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

IT_man

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

# q  q: u( |! B' ?, R/ Fwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
  L) d: O: Q# i, m1 u9 l0 `以下是 wordpress 短代碼的詳细介紹及進階應用。
/ A2 L- _' f) b) i' W
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
. Z) \* U, u, `3 U8 B- {/ t

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
" P. |; @' w  w

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
3 a( r2 a, }$ o! O- b

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

複製代碼

0 S5 u3 ~# M# f1 t0 z. K
$ j+ q0 G" x  `1. 簡單的短代碼
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
7 Q0 u7 f' m  k, U- Q/ U

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

8 B8 t3 [& x2 e$ d本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
4 e+ v, Y3 C3 L& {1.1 建立返回函數
/ S! X( Y- \! e當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。

1. function recent_posts_function() {
   
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   
3.         if (have_posts()) :
   2 w; d; b- f: Q5 S1 N
4.                 while (have_posts()) : the_post();
   & e+ w, W( o1 }6 r+ Z
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
     s6 ^9 t/ B) x  K
6.                 endwhile;
     b4 e9 e, E  G9 c7 H; }$ d
7.         endif;
   ( a0 V5 A. h6 V  H, f: i+ H6 J
8.         wp_reset_query();
   / e9 p: ^" F* w9 Q" q0 I2 i
9.         return $return_string;
   + r% N, t6 {8 E$ Y1 M/ S
10. }

複製代碼

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

5 E1 S$ b$ H4 i+ m1 O" F1.2 註册短代碼
. I1 K: @$ T0 s# J+ l# g3 \! k現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   ) T# C. |* ~. S" g9 e
2.         add_shortcode('recent-posts', 'recent_posts_function');
   
3. }

複製代碼

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

1. [recent-posts]

複製代碼

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

# B$ d4 Z. l+ [# T! l( j: H% ~
1.3 Hook into WordPress

1 b5 A+ n7 q2 t' r% E0 ^/ p  m  K  y為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
- j! k" x2 s' Z0 V( K% j

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){
   / o/ k# E) D6 k. d2 a7 U
2.         extract(shortcode_atts(array(
   / @) h; m+ H6 Q& r1 ]7 h! w; I7 l
3.                 'posts' => 1,
   
4.         ), $atts));
   
5. 
   
6.         $return_string = '<ul>';
   2 ~8 q0 C& T% U+ d% V$ n0 \' I$ i( j
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
8.         if (have_posts()) :
   . [9 F) C7 c' c! m- h
9.                 while (have_posts()) : the_post();
   * [; k( m) w  n# Z8 U4 X( y
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
      h8 P- m1 I' A  p# y
11.                 endwhile;
    7 X8 x3 ]4 J1 I( `( H5 V5 Y
12.         endif;
    ; m/ e( @0 z8 R8 C" [  p
13.         $return_string .= '</ul>';
    
14. 
    
15.         wp_reset_query();
    ! i* J5 o* i. ^( p$ k0 B
16.         return $return_string;
    
17. }

複製代碼

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

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

複製代碼

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

2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   6 g, K2 G3 W& Y& Z  s
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   
4.         ), $atts));
   ; U* U: O( J) a' v
5. 
   1 e7 k) X0 J& R
6.         $return_string = '<h3>'.$content.'</h3>';
   7 l& {- p; W6 L) D. p" Q) W
7.         $return_string .= '<ul>';
   
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   0 P- [; f/ F2 J
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    + U1 n6 R: E- C$ _! {
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
12.                 endwhile;
    
13.         endif;
    
14.         $return_string .= '</ul>';
    ( M7 X- C6 S0 Z% f. h
15. 
    ( T8 c2 k, K* s+ v; b6 f2 x
16.         wp_reset_query();
    7 ?" h: g( {& y8 }( g7 Y+ a
17.         return $return_string;
    
18. }

複製代碼

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

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

複製代碼

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

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

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

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

. v7 [5 M4 B; m$ J

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

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

複製代碼

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

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

4. TinyMCE編輯器增加短代碼按鈕
: M9 W' e1 i  m
雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類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() {
   " _$ K: a& N9 D/ Z! d  g
2.         tinymce.create('tinymce.plugins.recentposts', {
   $ c5 ~8 w9 s' \7 A* N! N
3.                 init : function(ed, url) {
   + @; E: ?. F3 B8 v9 Q
4.                         ed.addButton('recentposts', {
   ( x5 I8 Q8 h0 \" L3 O. y4 W3 q
5.                                 title : 'Recent posts',
   
6.                                 image : url+'/recentpostsbutton.png',
   ! d( B: a" T/ ~9 s6 O- x
7.                                 onclick : function() {
   , E2 H: C% [$ v8 a5 O1 J- s( t
8.                                         var posts = prompt("文章數量", "1");
   $ i9 [( k5 X, T
9.                                         var text = prompt("請填入列表標題", "最新文章");
   , O7 ]% [! W, m8 g3 u
10. 
    
11.                                         if (text != null && text != ''){
    8 C# a# n" `+ X  [+ ]
12.                                                 if (posts != null && posts != '')
    
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    3 m. J$ E" C7 l! B+ W% M1 Q4 `
14.                                         else
    
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    - z5 J/ }4 T% E8 V4 M# i
16.                                         }
    
17.                                         else{
    
18.                                                 if (posts != null && posts != '')
    2 k( i/ {* C. p- e2 ^
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    
20.                                                 else
    
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    " R; M+ l( l& P8 [
22.                                         }
    & |) S$ A& J6 r$ C' D. P
23.                                 }
    $ j3 C$ H. t  d4 j
24.                         });
    " j' h( P, B+ X5 `! s  N# E$ L
25.                 },
    
26.                 createControl : function(n, cm) {
    
27.                         return null;
    
28.                 },
    
29.                 getInfo : function() {
    . ]* u! ]: W0 k5 d- a' M  A8 \
30.                         return {
    7 c3 d" P# J1 g' K0 I9 c% P! L# J
31.                                 longname : "Recent Posts",
    8 z/ N! n; M2 \3 M9 v
32.                                 author : 'Specs',
    
33.                                 authorurl : 'http://9iphp.com',
    
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
      N8 K) A" I, i: I, V7 R
35.                                 version : "1.0"
    
36.                         };
    
37.                 }
    
38.         });
    
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    
40. })();

複製代碼

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

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

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

8 n( K1 U+ f7 F4 r. [. b' ?

4.2 註冊按鈕及TinyMCE插件
2 q5 {. @5 W% S3 w
9 f' J  s! R3 L  I/ j

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

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

1. function register_button( $buttons ) {
   8 G8 k: R! E4 r6 z8 P4 v; z
2.         array_push( $buttons, "|", "recentposts" );
   ' M" ^% D) d" D& v5 W4 x
3.         return $buttons;
   
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
! S' K5 E& C$ ^% X7 r5 b

1. function add_plugin( $plugin_array ) {
   ' \- d; k% W- y+ m
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   
3.         return $plugin_array;
   . A! N2 t: E; ^) f
4. }

複製代碼

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

1. function my_recent_posts_button() {
   8 |, x# [% ?- J; ^" T0 n
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   3 c* F9 ]+ x7 j3 w! J
4.         }
   
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   ! _2 L* z' r  w, N2 S
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   
8.                 add_filter( 'mce_buttons', 'register_button' );
   
9.         }
   
10. }

複製代碼

當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
& s+ g/ c. f) C/ c2 ~最後把函數勾到Wordpress初始化函數

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

複製代碼

3 J+ U, F3 z9 {9 V6 P$ I: F4.3 按鈕的用法

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

1 w0 v& j8 A( C1 A/ h

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

* n- n1 P) p( |2 H& f5 Z: P1 ]

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

. F' b1 D: k2 j1 m/ K0 x5 r8 _7 S

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

( k9 z# |8 R5 {7 }% e

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

參考文章: 1 2