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

IT_man

WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
4 q: Q5 }4 E8 C, u8 |' v+ W
& b6 _, p8 Z' h' R3 Uwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
3 n+ m! J1 f! X5 l, g% F以下是 wordpress 短代碼的詳细介紹及進階應用。

短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
: z( O  v# w* ~, Q- U, \

1. [recent-posts]

複製代碼

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

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
0 J) L- w% A+ {5 g$ ?2 Q

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

複製代碼

" {# W! z9 Z1 J: Z( t1. 簡單的短代碼
' M" E' F+ S! f: a! l: q; P. j- M' b本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
' Z( S5 Z; D/ @! u$ J) L1 ~/ w

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
# N3 p5 u. Z. U& q2 D( {+ j. j; o

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

本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
+ x+ A; ?" Q% _1.1 建立返回函數
& M/ Z! t* N1 r' H% X8 v. |8 f/ f當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
6 `3 I2 g! Q+ x7 E# t

1. function recent_posts_function() {
   + j) ~  C5 y* f! f
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   * {" g  E& S( {9 W" C" c
3.         if (have_posts()) :
   " m8 g, g& {  A5 D1 g* e; l
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   & h* B4 z! D$ S' l3 Y+ |. d
6.                 endwhile;
   4 h6 v+ `. r. G. T( @; I0 t
7.         endif;
   1 j0 V/ t5 l( v& m! H/ x( _& ?
8.         wp_reset_query();
   4 C! B" H" J8 @8 F
9.         return $return_string;
   + y) @( K; o1 F. E
10. }

複製代碼

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


6 V% O. u& c3 ]& n, b6 o3 G  D$ ]1.2 註册短代碼
' W  b# O0 ~! \4 }現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   5 {5 x- t9 W3 a8 T
2.         add_shortcode('recent-posts', 'recent_posts_function');
   7 u+ y  X6 D- ~; h" }% M' x
3. }

複製代碼

當在文章的內容中使用短代碼
' u  `' K( n8 T# @

1. [recent-posts]

複製代碼

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


) E: N1 p5 O3 s8 O4 t5 p( x1.3 Hook into WordPress

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

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){
   : @/ @, v2 ^, E* U& C: O$ n
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   
4.         ), $atts));
   0 S) r( |1 k5 |5 ?0 l& M1 M3 b
5. 
   
6.         $return_string = '<ul>';
   
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   & Z! J( `- P7 X* t. Q2 w  j  K
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
      X( [7 g$ X/ g, o& ]9 F/ V
11.                 endwhile;
    - A& I) ~- o" V- v
12.         endif;
    3 _9 i9 y6 _6 L2 L
13.         $return_string .= '</ul>';
    
14. 
    . g! v* e! f: v/ a
15.         wp_reset_query();
    # j9 Y5 E0 S) ?! v& s8 e; q9 N
16.         return $return_string;
    
17. }

複製代碼

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

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

複製代碼

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

2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   
2.         extract(shortcode_atts(array(
   * n: C0 Z$ `' u5 ?
3.                 'posts' => 1,
   
4.         ), $atts));
   0 T; R' p. F% {5 O0 X. t0 i- k
5. 
   % ]/ Y6 X0 M4 i; }6 ?
6.         $return_string = '<h3>'.$content.'</h3>';
   , m0 y7 V: B4 I# s
7.         $return_string .= '<ul>';
   1 o6 j6 P/ Q% F7 p6 e
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   : K, s' o4 g/ H, L5 |, o5 s
9.         if (have_posts()) :
   ; {4 B7 O) ^( i9 ?
10.                 while (have_posts()) : the_post();
    
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
12.                 endwhile;
    
13.         endif;
    
14.         $return_string .= '</ul>';
    
15. 
    
16.         wp_reset_query();
    9 m! b+ O% |3 e: d5 c, q+ _1 B+ x/ _, y
17.         return $return_string;
    
18. }

複製代碼

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

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

複製代碼

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

/ [# J2 {$ n' S3 I4 H8 x$ d

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

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

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

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

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

複製代碼

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

4 n/ m6 W/ P6 m' P5 ?

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

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

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  ) k: W) H& u7 g, e' S! {

0 f+ x- T: ]3 n( b" D5 c5 u2 M4.1 透過JS文件來建立按鈕

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

1. (function() {
   6 M% \1 S/ O4 T
2.         tinymce.create('tinymce.plugins.recentposts', {
   
3.                 init : function(ed, url) {
   
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   
6.                                 image : url+'/recentpostsbutton.png',
   8 F$ t) _4 p+ T1 c( {" D
7.                                 onclick : function() {
   
8.                                         var posts = prompt("文章數量", "1");
   4 N! p$ }- P( {  t) P+ ?
9.                                         var text = prompt("請填入列表標題", "最新文章");
   . ^  T! {6 d- \! j) m
10. 
    
11.                                         if (text != null && text != ''){
    ' I. ?4 _. d3 t% S5 @5 }% E$ P7 V, G
12.                                                 if (posts != null && posts != '')
    # s* d: b; G$ F7 @6 @7 X" ?1 K
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    
14.                                         else
    " W' Z! L. {8 {* T. U
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    ) ~4 o# @: K! i9 B  U- b  b9 _  e
16.                                         }
    - U6 m2 r) T$ Y7 N& G: i: b* \
17.                                         else{
    : b0 _4 }. D; f6 B* ?- E
18.                                                 if (posts != null && posts != '')
    0 P# _" a9 r! Z" J" G' V
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    
20.                                                 else
    . j2 |) E; f) z! u6 J
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    
22.                                         }
    4 `0 Y. |  X/ u% r/ u5 }# a
23.                                 }
    
24.                         });
    
25.                 },
    
26.                 createControl : function(n, cm) {
    
27.                         return null;
    
28.                 },
    / T5 K5 b7 _, W0 `' K, X4 U1 ^2 @
29.                 getInfo : function() {
    . g/ i, \, N! a1 h" C0 X, r
30.                         return {
    - x4 I& D" S1 J0 p3 d9 V! o1 }5 V
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    
33.                                 authorurl : 'http://9iphp.com',
    / g8 B. [* B2 k1 o
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    
35.                                 version : "1.0"
    8 g! @- d- I2 w3 h
36.                         };
    6 R3 q: H% s3 y, Q
37.                 }
    
38.         });
    , ^. K% F9 b  ^' g4 s- |
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    1 ]( q; N2 b& F8 j! J
40. })();

複製代碼

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

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

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

4.2 註冊按鈕及TinyMCE插件

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

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

1. function register_button( $buttons ) {
   9 S0 i# H1 B/ n2 s" q6 [8 e) [
2.         array_push( $buttons, "|", "recentposts" );
   
3.         return $buttons;
   
4. }

複製代碼

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

1. function add_plugin( $plugin_array ) {
   & S9 t! B6 C% W) Q. W
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   ; c  `& H3 E' A4 p  Q
3.         return $plugin_array;
   5 K( x  A9 |/ r& L, b6 y. q0 s+ O1 s
4. }

複製代碼

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

1. function my_recent_posts_button() {
   6 j4 D# a! ^) r
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   
4.         }
   6 H3 Q' I9 U7 H8 m; ^3 O
5. 
   , [9 p0 ]5 F( @( Z. n3 ?
6.         if ( get_user_option('rich_editing') == 'true' ) {
   5 h- K1 O7 [  b+ s
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   
8.                 add_filter( 'mce_buttons', 'register_button' );
   
9.         }
   
10. }

複製代碼

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

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

複製代碼

4.3 按鈕的用法

( l8 |, ?0 M7 W+ B

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

/ _6 Z$ V6 Q  n' [$ A

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

& u2 ~$ |' b) i1 ^( Q! c  x

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

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

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

參考文章: 1 2