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

IT_man

WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
) t# A' u3 t$ S. ^/ H- U0 Q6 B
wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
以下是 wordpress 短代碼的詳细介紹及進階應用。

: f  _. {6 F. S% B短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :

1. [recent-posts]

複製代碼

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

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

複製代碼

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

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

複製代碼

2 |' i# }8 C. z& m: x3 k3 }3 x
1. 簡單的短代碼
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
8 v8 k7 _, b2 T% ?

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
& z) \' f2 x5 @' E# x) \' K

• 建立一個函數 , 當 wordpress發現短代碼時會呼叫此函數 ;
• 藉由設置一個唯一的名稱來註冊短代碼 ;
• 把註冊的函數連結到wordpress的action上。
  3 D# N* f! x: k3 x. s! B

- m3 q) J1 f1 ~8 h4 F本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
0 M; m+ y1 C# D1.1 建立返回函數
/ g5 x8 V+ r6 Z: }當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
( {  C. w. m+ P2 R1 [3 ]  k  C

1. function recent_posts_function() {
   + N4 p" C1 M% X+ M7 V  a
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   
3.         if (have_posts()) :
   
4.                 while (have_posts()) : the_post();
   2 a9 e  s! {; ?% [  ]+ D2 _8 S4 e
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   
6.                 endwhile;
   6 q0 ]3 C* H% v! T0 Z, ^5 p
7.         endif;
   
8.         wp_reset_query();
     f+ \, }. f) e( s; B4 s) M
9.         return $return_string;
   
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
3 W9 h  ]( ~: x( u/ ]6 X7 C
% p( ^: A+ R* R! L' m
! E. B/ N4 G! `. @% Y4 I  D3 u1 \1.2 註册短代碼
' t1 E7 {4 v  h, ^% R- l4 s現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   / H( v* z  M0 O' Y2 \0 j
2.         add_shortcode('recent-posts', 'recent_posts_function');
   
3. }

複製代碼

當在文章的內容中使用短代碼
) }; }" z- ^% D) r( M1 j% P. C9 Y, y

1. [recent-posts]

複製代碼

將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。
$ d* R% F4 r2 O& t( X

4 d: F" E3 M; m5 d+ D$ i% }1 @1.3 Hook into WordPress
8 `3 N: I# n' m
為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
0 X3 h7 K5 b. _, q0 }8 E; x

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

複製代碼

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

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,
   - i; y0 c: Q/ a4 g! b
4.         ), $atts));
   
5. 
   8 V9 T, v0 T0 X# b" J, T
6.         $return_string = '<ul>';
   . l5 X. k. l! Z4 K: d
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    8 t2 @. S3 e# t, }0 P
11.                 endwhile;
    
12.         endif;
    
13.         $return_string .= '</ul>';
    
14. 
    
15.         wp_reset_query();
    2 {% F& Z4 y* F& [6 G# ^# v
16.         return $return_string;
    
17. }

複製代碼

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

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

複製代碼

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

: t0 Q) Q/ C5 E6 }) R) V& g2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   ' E7 I0 ^' i' c3 Q1 T( B1 ~
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   
4.         ), $atts));
   
5. 
   
6.         $return_string = '<h3>'.$content.'</h3>';
   5 A( @- W) u1 x4 m! i0 ?
7.         $return_string .= '<ul>';
   
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   . b( B' }  {/ U' Q3 T3 G, m  I( d
9.         if (have_posts()) :
   ( |9 N  z7 p8 m! r* \
10.                 while (have_posts()) : the_post();
    
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    # A6 Q2 M3 Y  H) y& G/ x: N
12.                 endwhile;
    
13.         endif;
    
14.         $return_string .= '</ul>';
    3 a/ V* E$ l4 {0 t. O2 ~
15. 
    
16.         wp_reset_query();
    
17.         return $return_string;
    4 |3 ]. j* P5 ^% R* }
18. }

複製代碼

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

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

複製代碼

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

7 I& {9 ?  m9 s% O3 H- z; Q

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

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

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

% m) ^: k" {7 ^5 h9 b) n3 M

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

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

複製代碼

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

$ X2 ]; o" D3 t/ f

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

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

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

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  5 ?7 p* V" A! I" @, _, t

4.1 透過JS文件來建立按鈕

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

1. (function() {
   - O& ]+ I. u0 ]$ M! {" H
2.         tinymce.create('tinymce.plugins.recentposts', {
   
3.                 init : function(ed, url) {
   
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   % |- D! g+ t! Q+ U2 j
6.                                 image : url+'/recentpostsbutton.png',
   
7.                                 onclick : function() {
   8 v& p3 F9 i; J, H8 [0 d4 V
8.                                         var posts = prompt("文章數量", "1");
   
9.                                         var text = prompt("請填入列表標題", "最新文章");
   
10. 
    ( p( j8 q9 f0 b6 d4 \. J8 I; V7 \
11.                                         if (text != null && text != ''){
    
12.                                                 if (posts != null && posts != '')
    
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    
14.                                         else
    
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    
16.                                         }
    
17.                                         else{
    
18.                                                 if (posts != null && posts != '')
    
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    
20.                                                 else
    1 V8 ~" D! }; X; e. Q3 K' F
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    . x1 p# \% K) |3 Y, }! |) p
22.                                         }
    
23.                                 }
    1 ]$ A1 p. M) D! C: ~' X" {) M
24.                         });
    % }& l/ m! n9 K' [3 U; k1 s
25.                 },
    0 Y1 {/ d+ _" E5 L# n. Y
26.                 createControl : function(n, cm) {
      _' I. X5 B$ H& L  s
27.                         return null;
    $ q6 Z2 [$ C3 k3 y2 e
28.                 },
    . ^: w$ _3 u4 ~
29.                 getInfo : function() {
    & z8 t! F; E9 j5 ^. l, X* g
30.                         return {
    ) R, }& Z% r* w1 I  {1 G
31.                                 longname : "Recent Posts",
    7 c; y, ]4 c- M5 e0 I+ e' d
32.                                 author : 'Specs',
    ; ]5 c7 f% d2 O; [1 c7 [
33.                                 authorurl : 'http://9iphp.com',
    
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    0 O: j, w- ~" v' c7 b/ F
35.                                 version : "1.0"
    * E  {, }: h5 H1 t& i
36.                         };
    
37.                 }
    9 Y- i: k- r  \9 b4 ~4 W  @
38.         });
    - \/ P# f3 X  ~/ _/ r( y
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    
40. })();

複製代碼

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

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

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

4.2 註冊按鈕及TinyMCE插件
" z3 h1 L& G: `& z- ^) J* V. n4 `) d

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

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

1. function register_button( $buttons ) {
   
2.         array_push( $buttons, "|", "recentposts" );
   7 B5 ]& g4 |6 y8 l: a
3.         return $buttons;
   / k$ _4 Z% ]( a6 f" N
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
! D( J2 L1 o. m0 W5 }6 m0 s# x7 {

1. function add_plugin( $plugin_array ) {
   ; W& W7 x+ O- P( e% h
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   % y2 ^% I3 X  o: A( C* R8 w3 x, _
3.         return $plugin_array;
   ( E7 ~1 K& x6 X1 D" x/ `
4. }

複製代碼

下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。
" L& {* s+ O2 q/ o  c7 b

1. function my_recent_posts_button() {
   
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   
4.         }
   , `" b, T/ i' B  F
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   & ]" D+ q7 w7 M- Y$ m; J" g- Q$ @) t
8.                 add_filter( 'mce_buttons', 'register_button' );
   
9.         }
   
10. }

複製代碼

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

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

複製代碼

4.3 按鈕的用法

( D$ q9 Q' y- z* c, j

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

4 g6 q* g0 j& \3 ?

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

  L7 @2 A: M4 Y. N

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

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

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

參考文章: 1 2