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

IT_man

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

wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
以下是 wordpress 短代碼的詳细介紹及進階應用。
! L; H) s+ ?# W* F: D0 w( Z
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
. n8 r# Q  B5 S

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
/ ~  g8 p; C* z8 g: H

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

複製代碼

- ~8 p/ k4 p2 i8 r' C
. s3 [2 L9 r& _) R1. 簡單的短代碼
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
; f+ {7 E% q5 ?1 a

• 建立一個函數 , 當 wordpress發現短代碼時會呼叫此函數 ;
• 藉由設置一個唯一的名稱來註冊短代碼 ;
• 把註冊的函數連結到wordpress的action上。
  

* |6 d! T% q5 B2 X+ P% B本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
1.1 建立返回函數
1 O$ `) ~" H- b當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
: |" G+ ^' S4 k" r1 F5 b

1. function recent_posts_function() {
   & E' }/ o6 w* I6 v% t" y
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   
3.         if (have_posts()) :
   
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   
6.                 endwhile;
   + o- q) M8 U3 _" `+ m1 `" E
7.         endif;
   
8.         wp_reset_query();
   
9.         return $return_string;
   " D& \  n! _6 u2 K" p- a# l2 c* n! [# w
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
& ~- p) I  f- c6 ~. ^

7 V  ~& C% k  X- K3 D! Q1.2 註册短代碼
現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   4 Q7 _& [# K; C/ s0 C
2.         add_shortcode('recent-posts', 'recent_posts_function');
   
3. }

複製代碼

當在文章的內容中使用短代碼

1. [recent-posts]

複製代碼

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


1.3 Hook into WordPress
4 J4 a; K" }% T8 @
5 J: X* A7 W4 Z6 ]5 J! W為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
* b2 e7 ]0 T/ v: e7 \+ N

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

複製代碼

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

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   * j* x2 Z1 X$ g
4.         ), $atts));
   
5. 
   # U6 t( S! s+ ?  v1 E
6.         $return_string = '<ul>';
   8 b" ]" p! C) J# X' _0 p: u: I
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   * T& x& X( y4 w
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   ' B* E9 X  i) v
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    5 S& E! s, s* l( e; ]
11.                 endwhile;
    
12.         endif;
    & H2 Q8 R* O7 Y; T" @: M
13.         $return_string .= '</ul>';
    , o$ r3 U0 h: m$ g" R# c* n
14. 
    
15.         wp_reset_query();
    
16.         return $return_string;
    
17. }

複製代碼

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

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

複製代碼

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

2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   . C$ m! q7 I0 T* w0 Q" B
2.         extract(shortcode_atts(array(
   : b/ N8 w' U+ O7 Q5 i# B! j
3.                 'posts' => 1,
   9 d  J1 z) Y; q6 t3 S6 V! ?5 n
4.         ), $atts));
   ' w' j$ Q, |0 R5 D$ e1 J8 X
5. 
   ) j! K. k7 n& z7 D5 U: k
6.         $return_string = '<h3>'.$content.'</h3>';
   5 ^! t% W8 n8 O3 g1 h, w
7.         $return_string .= '<ul>';
   ; b3 u5 K! l3 R) M8 ^
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   6 v, ]6 u" U8 j& c5 `+ T3 t
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    0 C+ \8 p) Y8 z/ b
12.                 endwhile;
    . T6 d7 p2 b9 k! e6 g0 Y
13.         endif;
    , G- I7 R$ i: o/ b
14.         $return_string .= '</ul>';
    / C5 m. p  }3 J. [1 R
15. 
    
16.         wp_reset_query();
    , G1 x! E; W- {! Y& z4 F. q
17.         return $return_string;
    
18. }

複製代碼

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

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

複製代碼

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

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

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

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

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

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

複製代碼

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

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

4. TinyMCE編輯器增加短代碼按鈕
4 ]! Z; x  L8 S" T
雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  

4.1 透過JS文件來建立按鈕

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

1. (function() {
   6 M* |" [& e2 R: ~) l) C2 a
2.         tinymce.create('tinymce.plugins.recentposts', {
     S7 S4 e5 Q  X1 c2 |5 M' D# a9 f
3.                 init : function(ed, url) {
   
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   ( _; m3 j9 G  }2 p5 ~
6.                                 image : url+'/recentpostsbutton.png',
   
7.                                 onclick : function() {
   
8.                                         var posts = prompt("文章數量", "1");
   / A) T1 C6 p% w& a" v7 O: b# K1 t( c
9.                                         var text = prompt("請填入列表標題", "最新文章");
   . |' i, G; L' m4 }
10. 
    : a( q9 l. L; b
11.                                         if (text != null && text != ''){
    & x- M9 n. U4 X: N0 x) }% E' T
12.                                                 if (posts != null && posts != '')
    1 F% n* s, A% L1 g# u: P
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    / o$ h) _: x& B% K. p
14.                                         else
    0 j$ U0 W1 D: N7 f7 u
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    " e* ], n+ ^2 {* x' |
16.                                         }
    ! T2 g2 I4 T5 y( c5 z& y
17.                                         else{
    3 N9 ]" x( r, L$ K9 k
18.                                                 if (posts != null && posts != '')
      Z' U2 w, K% `. S$ }
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    . L: @" g; L, H- E$ c
20.                                                 else
    ( \% l$ \1 n3 e0 y5 A" Z
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    
22.                                         }
    5 {  n1 Z8 Q" E/ s! s; M
23.                                 }
    
24.                         });
    
25.                 },
    
26.                 createControl : function(n, cm) {
    
27.                         return null;
    
28.                 },
    5 d1 ~8 I( M8 d2 I2 q# C
29.                 getInfo : function() {
    5 y+ ~/ H; V1 K
30.                         return {
    
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    $ Q( p0 H& k' H
33.                                 authorurl : 'http://9iphp.com',
    
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    
35.                                 version : "1.0"
    $ ^/ V  I2 Z8 W9 h  W' C; f
36.                         };
    
37.                 }
    0 ]6 q, }5 V/ D! W
38.         });
    
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    $ e. ]( E+ G5 H
40. })();

複製代碼

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

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

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

4.2 註冊按鈕及TinyMCE插件

. V. O" x& u: i7 Y/ o3 o

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

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

1. function register_button( $buttons ) {
   % D* z! z- y. d& v9 b
2.         array_push( $buttons, "|", "recentposts" );
   
3.         return $buttons;
   
4. }

複製代碼

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

1. function add_plugin( $plugin_array ) {
   4 p4 J6 h& M+ d+ ?/ p5 U7 x
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   
3.         return $plugin_array;
   1 s' c6 D- _" X) e1 H. M2 J; |. e
4. }

複製代碼

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

1. function my_recent_posts_button() {
   
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   5 D6 c; O& ?4 g2 a. S% X8 N
3.                 return;
   * n8 V6 o6 }9 r! }& S
4.         }
   ( t9 q% P6 E" M# P* G
5. 
   1 q0 g9 [+ P# }4 o# ?7 S
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   
8.                 add_filter( 'mce_buttons', 'register_button' );
   7 l2 O8 K; p; D0 a( V2 ~- s: o* B
9.         }
   
10. }

複製代碼

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

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

複製代碼

4.3 按鈕的用法

0 F( h6 ^9 T2 Z8 }

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

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

9 z4 x0 ~8 d0 g9 S" _0 D

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

: Y/ x- |# {1 f; q/ y

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

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

參考文章: 1 2