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

IT_man

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

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

短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
' `% U7 k+ s% o% v+ |: p

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
9 `. m2 j7 e/ G- g4 T5 ?5 V

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

複製代碼

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

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

複製代碼

( \) l; [& y0 g; A% E" R' g8 }1. 簡單的短代碼
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
( k  x; s8 j9 S* t* P" ~

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :

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

本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
. ^4 T0 c& V8 F1.1 建立返回函數
3 |' u) I' n5 }- w  ?5 H' X4 D當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
  A, R, I" J: y/ C

1. function recent_posts_function() {
   2 U! W& T/ D. v0 _
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   
3.         if (have_posts()) :
   
4.                 while (have_posts()) : the_post();
   % L4 _9 {; }3 h# s) Z
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   
6.                 endwhile;
   
7.         endif;
   2 e, y2 |9 @+ k' J! _- J# Y
8.         wp_reset_query();
   + B5 F/ Y0 C$ p; v8 e4 X1 d
9.         return $return_string;
   
10. }

複製代碼

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

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

1. function register_shortcodes(){
   
2.         add_shortcode('recent-posts', 'recent_posts_function');
   / q( q1 z) W. n- m5 Q
3. }

複製代碼

當在文章的內容中使用短代碼
9 \) w0 r0 y- D) C' s! ^+ u

1. [recent-posts]

複製代碼

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

; X" `' Z) x8 k: O; f9 n
1 d* B8 F8 b, i3 q5 O# b$ `1.3 Hook into WordPress

為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。

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

複製代碼

9 c: t2 {3 z! b) z* l: R; g1.4 測試短代碼
2 e+ C6 A3 i) F) i簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   ' e9 c! |0 l: }: l
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   / c, h" u- u5 `
4.         ), $atts));
   # A  t6 J; s- b) r6 _7 ?3 ?) k  v  f
5. 
   
6.         $return_string = '<ul>';
   ! x4 F- e4 }! N/ p+ Y! K
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   9 b9 s! G! E- X2 V) v
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   5 b/ u) }" T  x. _  j% D
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    " C  e; g  W0 f8 k: t' C! D# m7 P
11.                 endwhile;
    
12.         endif;
    4 p+ r4 d* E( v/ s9 I1 O* q, T: q
13.         $return_string .= '</ul>';
    ' k/ e5 ^& a- y( ~! n8 u- }' r9 W
14. 
    9 `! G( ~" [+ Z- Y7 n) ?: h
15.         wp_reset_query();
    
16.         return $return_string;
    / i$ S  c) ]* s0 N; O  S
17. }

複製代碼

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

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

複製代碼

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

2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   # |  g# }8 X/ N' z
4.         ), $atts));
   4 }, M/ n" V2 f1 f# u0 f4 r9 B0 p+ _
5. 
   
6.         $return_string = '<h3>'.$content.'</h3>';
   4 ~5 k/ E& F3 p$ }
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>';
    7 E7 A5 L5 Y; R1 z/ m  f* f' v! ~; b
12.                 endwhile;
    : R* y& J6 c; L0 b, B
13.         endif;
    5 A1 c( {# N) Z' s
14.         $return_string .= '</ul>';
    . n* F8 D" s  V" _, ~
15. 
    
16.         wp_reset_query();
    4 L6 d6 D- E0 L8 ~, A1 j' u
17.         return $return_string;
    1 z- k$ W7 r  S  I0 B' m8 I& O
18. }

複製代碼

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

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

複製代碼

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

- T; s( c, O) B! n6 K

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

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

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

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

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

複製代碼

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

, ~0 n/ f4 x0 l' D( P' o& w0 H0 d4 Z

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

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

4 Y( [+ ]* M6 b9 v. E. ~& p雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  " _! I4 ?5 H: U: M" S; l$ Y

4.1 透過JS文件來建立按鈕

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

1. (function() {
   2 Z9 W3 j' k# X/ A6 |8 n2 H3 H- d: }
2.         tinymce.create('tinymce.plugins.recentposts', {
   : ]% |+ V' r  F: `9 \2 }
3.                 init : function(ed, url) {
   
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   
6.                                 image : url+'/recentpostsbutton.png',
   7 V# u# A4 @) g% l) ?1 Q  d$ G
7.                                 onclick : function() {
   % ?- y/ t8 A7 p3 d2 Z; U; S
8.                                         var posts = prompt("文章數量", "1");
   
9.                                         var text = prompt("請填入列表標題", "最新文章");
   4 U  A. B; [$ c: ~' B/ I/ [
10. 
    
11.                                         if (text != null && text != ''){
      D9 ?( {9 X5 ?4 s8 j7 e5 V
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]');
    ) D1 C" ?9 g- o" P
16.                                         }
    ) f1 H) z( E7 h6 s3 u: D! V, O
17.                                         else{
    4 j6 i% y) w8 v$ f/ s- z
18.                                                 if (posts != null && posts != '')
    7 ?0 S% d9 y/ T: {1 }# a+ F1 S
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    
20.                                                 else
    
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    3 X. f( H  W; |, S& q
22.                                         }
    : D" L/ f3 d- Q( H' e* R+ {- Q. R
23.                                 }
    
24.                         });
    + ]; l( e; M, d( b9 ~: \  W) W* U
25.                 },
    % d+ A9 R1 v/ A6 C2 L/ E
26.                 createControl : function(n, cm) {
    
27.                         return null;
    , `; F. j( L+ H4 U) N( l, k9 \# t
28.                 },
    7 W8 q1 y( V* x9 n( I
29.                 getInfo : function() {
    9 c$ ~- s( l( I0 A, _7 g/ S
30.                         return {
    " n* f9 Q4 n$ L1 L
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    4 c5 z+ R( H# u  z4 ^
33.                                 authorurl : 'http://9iphp.com',
    . b1 V  {1 Z' V7 x; a
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    
35.                                 version : "1.0"
    + v" m* o* ]' p& @/ f8 z+ e5 Q& E
36.                         };
    
37.                 }
    4 g" l1 Q' U: M5 ]4 e+ x
38.         });
    # y) J6 ?1 f3 a' Z% o6 ~
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    
40. })();

複製代碼

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

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

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

7 \) y7 C2 m$ g, p

4.2 註冊按鈕及TinyMCE插件

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

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

1. function register_button( $buttons ) {
   
2.         array_push( $buttons, "|", "recentposts" );
   
3.         return $buttons;
   - U' E! K; U7 k2 }9 q
4. }

複製代碼

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

1. function add_plugin( $plugin_array ) {
   2 `0 s* z' w0 p# q4 o' B: c4 l& R" K
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   6 q6 H0 f( N6 I2 f/ C6 B" c4 L' b
3.         return $plugin_array;
   
4. }

複製代碼

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

1. function my_recent_posts_button() {
   5 `7 t2 J- ^* o* C9 P0 D* ]
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   
4.         }
   
5. 
   ) p  B8 y( S- ~1 @0 \& c. Q
6.         if ( get_user_option('rich_editing') == 'true' ) {
   . {+ `& C$ F* I) @% v9 D+ I) H+ S
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   
8.                 add_filter( 'mce_buttons', 'register_button' );
   3 `! @$ {) s# H, w2 M* w/ D' K/ w
9.         }
   
10. }

複製代碼

當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
8 d7 m, R6 C- C! x! |. x, s. q4 q最後把函數勾到Wordpress初始化函數

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

複製代碼

4.3 按鈕的用法

6 L: }3 r) ~2 L8 u" F$ U' }

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

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

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

9 ]7 z' s+ [4 \1 A  e& Q9 a- m

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

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

參考文章: 1 2