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

IT_man

WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
4 D* A+ o1 [- x3 {8 r
3 }# C( ?( b4 u7 N1 T3 X! nwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
以下是 wordpress 短代碼的詳细介紹及進階應用。

9 q# G7 v* z. L1 K3 J短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
: _- e9 C- m  P0 M

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
* H& ~, M8 A5 p+ J7 G( J

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

複製代碼

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

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

複製代碼

$ l8 h0 T) _( w: a1 w1. 簡單的短代碼
/ ]5 _% \1 A0 b8 X本教學的第一部分 , 我們會建立下列短代碼的程式碼 :

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
0 Y* [7 |. |3 K% D$ K0 \0 c

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

本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
5 ?. S- S# O, E9 x1.1 建立返回函數
" w5 \* W3 p& l8 b! K1 a/ p7 {當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。

1. function recent_posts_function() {
   
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   4 l  w& N& T# L: ]& O
3.         if (have_posts()) :
   
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   ! |; Q3 h9 l5 y+ ~; Q. y
6.                 endwhile;
   4 I8 X; l% T3 B$ N6 w
7.         endif;
   4 S6 m1 j6 T# i* |3 U
8.         wp_reset_query();
   8 a8 x3 y7 J3 Y' E% U/ u* I8 G
9.         return $return_string;
   7 U: e  f. d& B
10. }

複製代碼

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


" |0 M0 B0 P; y. t" I1.2 註册短代碼
/ {% i5 G1 Y, W- o$ V. x1 ~/ C現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   4 b) \9 Z+ ?/ i6 g: |) y4 d
2.         add_shortcode('recent-posts', 'recent_posts_function');
   7 S5 j3 o. g+ y( n9 q3 o/ ^- }3 P- T
3. }

複製代碼

當在文章的內容中使用短代碼
2 M' W: Z+ O8 b

1. [recent-posts]

複製代碼

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

  b- F. f7 K8 n, v8 H) {+ }( {3 N
1.3 Hook into WordPress

為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
& r" A/ a. n" p; e9 \& [$ p

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

複製代碼

6 U4 G- q2 E4 Y" o9 l% ]1.4 測試短代碼
5 T: S: k* i' D/ b8 g簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

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,
   
4.         ), $atts));
   
5. 
   
6.         $return_string = '<ul>';
   
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   , F$ O2 W$ B& q8 z
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    0 m6 Q1 c5 }+ P  @
11.                 endwhile;
    
12.         endif;
    & v6 T: K4 r1 v& D
13.         $return_string .= '</ul>';
    " `/ J$ U, A# n1 a. i7 i
14. 
    
15.         wp_reset_query();
    
16.         return $return_string;
    4 m- ^$ o; a) k9 S) b0 t& l1 N8 i1 R
17. }

複製代碼

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

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

複製代碼

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

: s3 h8 m: V& ^) S/ `& z2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   
4.         ), $atts));
   % D) k4 E0 C5 r7 ?  A+ P
5. 
   
6.         $return_string = '<h3>'.$content.'</h3>';
   
7.         $return_string .= '<ul>';
   5 N& T: v7 U  @' W& y& J: O
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   1 B; t( j8 s$ v) ~5 q3 I
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    ' k. {9 J& f- I: P; Q2 M0 w' G* i
12.                 endwhile;
    
13.         endif;
    
14.         $return_string .= '</ul>';
    0 m- M9 |+ G! |% M" c2 X
15. 
    2 v6 ?' `) E# k9 k( q
16.         wp_reset_query();
    
17.         return $return_string;
    ) w7 a5 V' X) Y0 h) D& U
18. }

複製代碼

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

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

複製代碼

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

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

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

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

5 q. b3 o* C# C  |% w

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

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

複製代碼

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

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

4. TinyMCE編輯器增加短代碼按鈕
+ s+ J5 W9 }& G& a9 [/ }# V% r  t
; l* V4 j" w! Z% I3 x' e雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  

/ _  ]% Y6 l9 r8 Z& f. j4.1 透過JS文件來建立按鈕

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

1. (function() {
   % ^. u# B. z6 O) u( ~
2.         tinymce.create('tinymce.plugins.recentposts', {
   
3.                 init : function(ed, url) {
   
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   
6.                                 image : url+'/recentpostsbutton.png',
   
7.                                 onclick : function() {
   + v( s' ~) n; [$ h) d6 c. B; x
8.                                         var posts = prompt("文章數量", "1");
   
9.                                         var text = prompt("請填入列表標題", "最新文章");
   
10. 
    & j4 f5 r' B2 j' l
11.                                         if (text != null && text != ''){
    
12.                                                 if (posts != null && posts != '')
    
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    ( P/ J2 x) Z; P" |: l
14.                                         else
    
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    
16.                                         }
    6 T8 e, ~( Q0 w. j9 E( ^5 }) ]7 T
17.                                         else{
    
18.                                                 if (posts != null && posts != '')
    + [7 e5 V* v5 s  }9 K5 ]
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    
20.                                                 else
    8 z) p$ I0 C; {" v: a$ B3 e3 @! O
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    5 @( i% O6 a. J$ `
22.                                         }
    
23.                                 }
    , \# i0 Z7 I/ d1 s% K; E# d( b
24.                         });
    
25.                 },
    . }& w* Z" @, E
26.                 createControl : function(n, cm) {
    " E( L/ R" U* M' V8 \
27.                         return null;
    
28.                 },
    
29.                 getInfo : function() {
    
30.                         return {
    
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    ! o0 _4 K. a  ~/ r9 H2 K$ h& P( B+ I
33.                                 authorurl : 'http://9iphp.com',
    5 ^! f3 j/ ]+ e5 t  h0 w4 |
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    , |; m' Z  L! O. L: c3 ^
35.                                 version : "1.0"
    ) m& U" o- \6 [8 ?; K1 O5 ]6 W: W
36.                         };
    
37.                 }
    
38.         });
    ; ^6 U6 j7 Q' b4 K) |7 `
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    
40. })();

複製代碼

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

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

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

' f) d! v$ F9 x8 y/ ]

4.2 註冊按鈕及TinyMCE插件

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

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

1. function register_button( $buttons ) {
   % y7 X3 L# }' o0 a9 O! Q! X1 v
2.         array_push( $buttons, "|", "recentposts" );
   
3.         return $buttons;
   
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
( x+ G" O# S* `7 Y, E* z( n

1. function add_plugin( $plugin_array ) {
   ( u1 n9 K" `2 o& y- U# `
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   
3.         return $plugin_array;
   
4. }

複製代碼

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

1. function my_recent_posts_button() {
   9 z, ^5 {1 k7 i3 J3 [
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   # n* s7 u0 |  C) o5 U2 a  i) W& I, i
4.         }
   
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   . l5 @& c  t& L' x) g7 F( k: ~
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   " P* R' F2 _7 C9 Q
8.                 add_filter( 'mce_buttons', 'register_button' );
   
9.         }
   1 C& }2 e" z# f: ]
10. }

複製代碼

當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
* I3 p3 _# H2 S5 y; F1 i+ ?$ Y# r最後把函數勾到Wordpress初始化函數

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

複製代碼

2 F% t5 Q7 d9 V7 Q; z4.3 按鈕的用法

4 T3 K" d  Q1 P5 t+ u$ K

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

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

) ?7 p0 x- C0 `2 S4 R% {. [

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

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

% W# }. a: d1 e2 i

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

參考文章: 1 2