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

IT_man

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

) L3 D' ?- q# J5 O短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :

1. [recent-posts]

複製代碼

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

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

複製代碼

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

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

複製代碼

1. 簡單的短代碼
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
. f: H4 R* ]. Z$ S5 X0 I

• 建立一個函數 , 當 wordpress發現短代碼時會呼叫此函數 ;
• 藉由設置一個唯一的名稱來註冊短代碼 ;
• 把註冊的函數連結到wordpress的action上。
  8 Q, ]. {+ Z$ \$ v8 R1 _: e

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

1. function recent_posts_function() {
   - l7 F* {" F8 G% o0 T  L/ z
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>';
   $ [' M& P/ x: H  q8 t
6.                 endwhile;
   $ [4 u4 r3 E3 M. l( ?
7.         endif;
   ; N; S9 @- h( o2 F
8.         wp_reset_query();
   ( h: q; r4 [, s) k: |! A
9.         return $return_string;
   + c. |7 L2 [+ P4 P
10. }

複製代碼

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

4 X7 f% G2 _# Q* W4 ]
* b% w% _5 A. Y! L1.2 註册短代碼
現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   $ D$ `* o: P. ^% o
2.         add_shortcode('recent-posts', 'recent_posts_function');
   6 {2 `& F% U# m0 o, c* z+ I
3. }

複製代碼

當在文章的內容中使用短代碼
( X, C& r! u9 _  a8 K$ j+ l

1. [recent-posts]

複製代碼

將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。
# |& ]- Y7 \( j: c! C, f
- m; E; i9 Q# B
( s+ x7 a* [' W$ C1.3 Hook into WordPress

5 j, V; [( {1 m為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。

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

複製代碼

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

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   
2.         extract(shortcode_atts(array(
   1 T; T" J4 s& d+ V
3.                 'posts' => 1,
   
4.         ), $atts));
   . I: o* ^. y+ r8 g5 ]1 @$ n
5. 
   . {; p5 D6 Q$ u" N  M
6.         $return_string = '<ul>';
     `5 S3 N, T. d" Q; {3 }9 F# b  t1 [
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
8.         if (have_posts()) :
   ; Z1 I& u$ _" v  y3 q# c% ^
9.                 while (have_posts()) : the_post();
   8 n% A4 F# j! x( a. j2 m1 f2 _
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
11.                 endwhile;
    
12.         endif;
    
13.         $return_string .= '</ul>';
    8 n  @8 _/ H  A8 [5 N
14. 
    
15.         wp_reset_query();
    
16.         return $return_string;
    1 y& {: q" x, `4 y: x
17. }

複製代碼

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

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

複製代碼

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

3 k3 |/ w" E! I4 q6 E8 y, N; _2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   8 f/ f! f1 F0 \' L: [% u4 w
2.         extract(shortcode_atts(array(
     ]7 x9 h' z/ n' G& s0 u5 k, V
3.                 'posts' => 1,
   
4.         ), $atts));
   2 V! _; h( t' K, ~' P5 V8 _1 x
5. 
   ; a5 E7 f% E3 m" L7 z3 ]
6.         $return_string = '<h3>'.$content.'</h3>';
     h0 \- R9 [6 k' U! F( m2 s
7.         $return_string .= '<ul>';
   
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    5 x" h" G- u* p/ X4 t
12.                 endwhile;
    + S' }4 @& I9 A
13.         endif;
    
14.         $return_string .= '</ul>';
    
15. 
    
16.         wp_reset_query();
    
17.         return $return_string;
    / k6 C9 V) H1 O6 O# P
18. }

複製代碼

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

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

複製代碼

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

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

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

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

8 Q1 u, b2 @) `! @

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

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

複製代碼

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

) P5 l/ Z7 y' h$ \7 _* X0 L0 ]) r

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

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

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  # Q- m& s2 P" K: F7 L" P

9 w8 E6 I1 K0 }4 [7 {4.1 透過JS文件來建立按鈕

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

1. (function() {
   
2.         tinymce.create('tinymce.plugins.recentposts', {
   " U- m+ F; C/ G
3.                 init : function(ed, url) {
   " [# a8 z# w% @0 M1 f/ i
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   2 f9 i7 j0 _( [0 ?  ?# U
6.                                 image : url+'/recentpostsbutton.png',
   2 \* ~( e1 [, a3 I( s% r3 X! l
7.                                 onclick : function() {
   $ v5 P# |+ y9 C" m$ p, O( }/ w  S
8.                                         var posts = prompt("文章數量", "1");
   
9.                                         var text = prompt("請填入列表標題", "最新文章");
   1 M5 q+ d" g* y2 H+ o: O
10. 
    
11.                                         if (text != null && text != ''){
    
12.                                                 if (posts != null && posts != '')
    
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    
14.                                         else
    4 N% X  \( R; N7 V: a1 u0 |
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
      h, _/ M9 f. t5 Q
16.                                         }
    ; X. ?! q& M  s+ J6 ~7 e
17.                                         else{
    . W7 @8 c9 e0 |# U
18.                                                 if (posts != null && posts != '')
    6 o2 k& z$ C* p, I# z4 i5 S4 a
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    
20.                                                 else
    7 j7 }# H9 e4 y7 o
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    ( K: o+ n/ f% B* P8 W3 h
22.                                         }
    6 r' f& O3 x& q* f
23.                                 }
    / _) D: U, v/ |/ U; P* J. a8 K/ F
24.                         });
    
25.                 },
    
26.                 createControl : function(n, cm) {
    
27.                         return null;
    5 c" U8 C  ]/ m) _- z
28.                 },
    5 r6 h3 g$ s" `$ o, q) z4 j% A
29.                 getInfo : function() {
    
30.                         return {
    
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    
33.                                 authorurl : 'http://9iphp.com',
    
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    4 s8 K& d4 _, C  b! u) }
35.                                 version : "1.0"
    8 l- M  i  t9 e; c1 C9 e3 `2 ^5 P# K
36.                         };
    1 u+ B: B6 q+ N
37.                 }
    
38.         });
      D, P5 f: @5 R3 \, p
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    ) [6 o+ j3 |  q$ P3 R- N
40. })();

複製代碼

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

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

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

4 \2 b* I9 i- Y2 d

4.2 註冊按鈕及TinyMCE插件
) D6 }- p: J1 p9 G; l3 G- Z0 f

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

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

1. function register_button( $buttons ) {
   . Y: ]* e' d( G; b/ t, Y( n
2.         array_push( $buttons, "|", "recentposts" );
   
3.         return $buttons;
   
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
0 v7 S4 m& N, _" }/ j" Z

1. function add_plugin( $plugin_array ) {
   
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   & \7 m. ^4 F, L
3.         return $plugin_array;
   
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') ) {
   
3.                 return;
   ' Y, ^, s" i% p: s9 N
4.         }
   ' X5 @0 E  R8 d* V
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
     l# M6 L  N/ c! N, P) h5 N, ^& x
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   
8.                 add_filter( 'mce_buttons', 'register_button' );
   # x& ]2 l5 t5 _! Q# l2 c; D& H
9.         }
   
10. }

複製代碼

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

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

複製代碼

4.3 按鈕的用法

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

5 K+ S4 y- D  n, |, l2 a. R

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

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

, Z/ z+ \6 J' I! s, }4 E+ j

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

& h1 i7 \+ z% W% i  ?6 H% ?

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

參考文章: 1 2