WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕[含4張圖]

IT_man

tid=39737&WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)

wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
+ ^+ B; m2 s8 \! F6 y0 D  Y8 q以下是 wordpress 短代碼的詳细介紹及進階應用。

短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
8 A7 T. w9 u/ o* X

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :

1. [recent-posts posts="5"]

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :

1. [recent-posts posts="5"]Posts Heading[/recent-posts]

複製代碼

1. 簡單的短代碼
5 i: k0 a% B' x8 T本教學的第一部分 , 我們會建立下列短代碼的程式碼 :

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
" P: B' W# f; ]% b. Y7 l

• 建立一個函數 , 當 wordpress發現短代碼時會呼叫此函數 ;
• 藉由設置一個唯一的名稱來註冊短代碼 ;
• 把註冊的函數連結到wordpress的action上。
  6 ^$ v+ N" I8 y7 k) G  I

本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
1.1 建立返回函數
1 I0 k# R$ P' ?* I當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。

1. function recent_posts_function() {
   
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   
3.         if (have_posts()) :
   / r, F  `2 Z' p5 ~# j, f6 U/ F
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   ! c& F, J: R' a0 }$ z6 i/ x
6.                 endwhile;
   : Q# [$ t: [9 V" [
7.         endif;
   , L+ z! E9 E6 }; d* W, Q7 v
8.         wp_reset_query();
   - g# Q) h% {* N4 d
9.         return $return_string;
   
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
# R- J1 F- [2 m- @+ i

1.2 註册短代碼
現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   ' F. O- k, R8 o
2.         add_shortcode('recent-posts', 'recent_posts_function');
   1 c6 p, U" K/ q3 s7 k$ d
3. }

複製代碼

當在文章的內容中使用短代碼
2 l8 V+ b2 Q* B6 K, l" k, y5 H

1. [recent-posts]

複製代碼

將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。

& {& @& E; x' [
' G  b9 b+ r  a1.3 Hook into WordPress
1 M# U: s2 E$ n9 ^
為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
3 {: q3 ~$ Q; e& b0 D

1. add_action( 'init', 'register_shortcodes');

複製代碼

1.4 測試短代碼
簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

短代碼是非常有彈性 , 因為它讓我們加入參數可讓它們有更多的功能。 假設我們必須要顯示某一特定數量的最新的文章。 為了達到這個目的 , 我們需要給短代碼指定其他選項以顯示最近的文章數。

我們需要使用兩個函數 ,第一個是內建在 wordpress 的shortcode _ atts ( ) 函式 , 它把用戶的短代碼屬性與本地屬性結合在一起 , 並填入到想要的位置。 第二個是 PHP的extract() 函数 , 顧名思義 , 它萃取出短代碼中的各個屬性。

展開我們的返回功能 , 我們新增一個參數 $atts, 它是一個陣列,從中可以提取到我們需要的文章數。 我們查詢資料庫來取得指定數目的文章 , 並傳回一個列表 :

1. function recent_posts_function($atts){
     V# Z1 t& _& x# U# H2 J
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   
4.         ), $atts));
   
5. 
   5 A* h$ D' Y7 a3 V) L" R/ E+ E' Y
6.         $return_string = '<ul>';
   / i! J# F9 b1 X' T
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
8.         if (have_posts()) :
   - v- h! n) v/ K# E4 n
9.                 while (have_posts()) : the_post();
   
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    ( v! S8 h& L/ O. s( R  g
11.                 endwhile;
    8 H  n: A+ r& C; e/ y) N! r
12.         endif;
    
13.         $return_string .= '</ul>';
    " N5 |+ L2 a0 U1 |' \$ c4 R: y/ |
14. 
    2 U+ j7 ]7 ~; k8 L  ]
15.         wp_reset_query();
    
16.         return $return_string;
      h/ y9 ?* u' f6 X& m5 M; f" T! t) D! {
17. }

複製代碼

如果使用者未指定此選項 , 1 將是預設值。 我們可以加入多個屬性使短代碼接受更多的參數。 使用這項強化函數 , 我們就可以指定調用最新文章的數量 :

1. [recent-posts posts="5"]

複製代碼

當顯示於瀏覽器 , 您就可以看到最近的五篇文章列表

8 H( e2 w3 |' v3 z0 R% w7 p2.2 短代碼中增加内容

我們可以繼續擴展我們的短代碼、新增一些內容作為參數 來傳遞, 例如"最新文章列表的標題"。 若要達成此目的 , 我們需要在返回函數中新增第二個參數$content , 並把它顯示在列表前面的一個 <h3> 標簽中。新的函數如下：

1. function recent_posts_function($atts, $content = null) {
   ) W  f7 h% P" U; X
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   , I* W9 ]$ B. k& D) g8 l
4.         ), $atts));
   
5. 
   
6.         $return_string = '<h3>'.$content.'</h3>';
   & Y8 F. R6 w1 {- ^; r3 m
7.         $return_string .= '<ul>';
   ! v1 G4 g0 d' t
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   0 }  R9 Y. d- @+ E' j
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    8 l9 V" [$ l: e8 W, |8 x
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
12.                 endwhile;
    
13.         endif;
    " a" m" l5 V! w$ R
14.         $return_string .= '</ul>';
    
15. 
    
16.         wp_reset_query();
    # N8 J- i: n4 x6 j: |
17.         return $return_string;
    ' G3 @& K6 T+ _# C2 m: x
18. }

複製代碼

這種短代碼類似於一個HTML標簽：

1. [recent-posts posts="5"]This is the list heading[/recent-posts]

複製代碼

除了文章列表多了一個標題，其餘的內容和上一個示例是一樣的：

3. 在任何地方顯示短代碼

3.1 在側邊攔小工具中使用短代碼

預設情況下 , 側邊欄小工具是忽略短代碼的，您可以將此程式碼放在小工具

我們可以採用一行程式碼來啟用這個函數 , 為了使側邊欄小工具支援短代碼 , 新增以下的程式碼 :

1. add_filter('widget_text', 'do_shortcode');

複製代碼

現在不需要修改任何其他地方 , 刷新頁面, 側邊欄將會正確地顯示

0 J+ E7 H/ F8 y" |/ l2 ^

同樣的，在評論中啟用短代碼：

1. add_filter( 'comment_text', 'do_shortcode' );

複製代碼

在摘要中啟用短代碼：

1. add_filter( 'the_excerpt', 'do_shortcode');

複製代碼

4. TinyMCE編輯器增加短代碼按鈕

' J) `1 f! }* x雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。

要解決這個，我們可以給 TinyMCE編輯器增加一個按鈕，使用戶可以透過簡單的點擊來增加短代碼。建立這個按鈕僅需兩個步驟：

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  * Q6 C; u' Y' K) K; F. ^4 G5 G

7 i# [  u  I1 z4 `4.1 透過JS文件來建立按鈕

JS文件是透過 TinyMCE API 來註冊 TinyMCE 插件的。我們在主題的 js 目錄下(/wp-content/themes/你主題名稱/js/)建立 recent-posts.js ，並貼進去下面的代碼（需要把按鈕圖片檔(/wp-content/themes/你主題名稱/js/recentpostsbutton.png)也放在同一個目錄）：

1. (function() {
   . b+ W4 w6 i1 J( O
2.         tinymce.create('tinymce.plugins.recentposts', {
   . \  Q, h9 j# {8 X! K8 q
3.                 init : function(ed, url) {
   
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   : S5 ?& S: c4 Z2 ~
6.                                 image : url+'/recentpostsbutton.png',
   3 w, ?" C, N0 Z' T7 G
7.                                 onclick : function() {
   5 ~5 }' K5 G+ z
8.                                         var posts = prompt("文章數量", "1");
   
9.                                         var text = prompt("請填入列表標題", "最新文章");
   
10. 
    9 G' i3 O1 V0 T% f- l
11.                                         if (text != null && text != ''){
    
12.                                                 if (posts != null && posts != '')
    
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    - Z+ d4 m" G! m+ ^" ^# Z# Z/ i
14.                                         else
    
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    
16.                                         }
    
17.                                         else{
    & y" h8 p& j1 J, f
18.                                                 if (posts != null && posts != '')
    5 N) ^: r2 Z& G, c7 _0 Q1 ?& t3 f
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    " c% U1 Q7 x5 h4 ~% D  E! b, f& w
20.                                                 else
    + ^3 C+ _' K" R9 \& {$ m
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    6 N8 v  @$ Q8 r8 a
22.                                         }
      v8 M9 M. m3 Y- y  Z
23.                                 }
    
24.                         });
    
25.                 },
    
26.                 createControl : function(n, cm) {
    8 V8 z( n- X' F8 s' ]
27.                         return null;
    - J: \8 e% t; E6 |& k
28.                 },
    1 K5 {- q  @0 e9 O9 W9 P  _
29.                 getInfo : function() {
    
30.                         return {
    
31.                                 longname : "Recent Posts",
    2 d3 y) a% S; D9 k* Z# L
32.                                 author : 'Specs',
    
33.                                 authorurl : 'http://9iphp.com',
      I: {) d8 g; x3 D' P7 Z. u( {
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    ; j# h$ T! i: i5 ?
35.                                 version : "1.0"
    
36.                         };
      O, f& E8 v: m0 `6 A/ `
37.                 }
    + O& B, d9 H; o( v
38.         });
    " Q1 T- z6 v' W, O* t
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    8 F1 M: v/ r: D6 [2 E
40. })();

複製代碼

我們透過呼叫 tinymce.create() 建立了一個插件。代碼中最重要的是 init() 函數，我們定義了一個名字，一個icon文件及 onclick() 事件處理程序。

在 onclick() 函數的前兩行，依序彈出兩個對話框讓用戶輸入文章數量及列表標題兩個參數，然後根據用戶輸入，把短代碼插入到編輯器中。

最後，TinyMCE插件透過 add() 函數增加到 PluginManager。現在我們已經成功的整合了 [recent-posts] 短代碼到Wordpress中。

4.2 註冊按鈕及TinyMCE插件

: J# U0 D$ u: R4 D

當您完成建立的JS 檔 , 我們現在需要註冊它和短代碼按鈕。 因此我們建立了兩個函數並把它們繫結至適當的 wordpress 過濾器中。

第一個叫做 register_button() 的函數把短代碼增加到按鈕陣列中，在現有按鈕和新按鈕之間增加分割線。

1. function register_button( $buttons ) {
     Q/ k0 }8 u' _
2.         array_push( $buttons, "|", "recentposts" );
   8 @( O4 }! e, O! T! J; e( z$ n: I
3.         return $buttons;
   " D( Y% Q5 l5 ]" G, \; \1 k
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。

1. function add_plugin( $plugin_array ) {
   9 Y: N2 f/ Z8 O3 C
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   . `, Z" S2 _5 j+ V' }
3.         return $plugin_array;
   
4. }

複製代碼

下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。

1. function my_recent_posts_button() {
     j, W) o. p0 m
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   # {+ q6 \; S* I1 n! R* T. k, A6 {
4.         }
   
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   
8.                 add_filter( 'mce_buttons', 'register_button' );
   " @% [  f1 m/ n5 J, g
9.         }
   
10. }

複製代碼

當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
最後把函數勾到Wordpress初始化函數

1. add_action('init', 'my_recent_posts_button');

複製代碼

4.3 按鈕的用法

9 m" A1 T" U- T% N/ t& Z3 m

為了測試程式碼是否正確，我們打開一篇新的文章，這時一個我們剛剛定義的按鈕是不是已經出現在第一行的末尾了？如下圖所示：

點擊按鈕的時候，會彈出對話框讓我們輸入文章的數量：

  z1 u, O: y9 x3 W4 a) w/ H/ X

輸入完點擊確定後，會彈出第二個對話框，讓我們輸入列表的標題：

7 k. t! I, \, g

參數留空的話，不會出現在最後的代碼中。最後，短代碼會新加到編輯器中：

* ~; F: T6 O# J+ x

到此就大功告成了。想要增加其他功能的短代碼及按鈕可以參考上面的教學，如法炮製舉一反三，相信可以製作出符合各位需求的短代碼功能。

參考文章: 1 2