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

IT_man

WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
$ u. r, s# R( B6 y' l
) H2 W2 I+ n/ i( g, fwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
以下是 wordpress 短代碼的詳细介紹及進階應用。

- A# i8 j6 s1 h( Y短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
4 V3 [/ @8 `. h' _) c' Y3 J

1. [recent-posts]

複製代碼

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

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
% i' C' {. z" b# x& C

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

複製代碼

1. 簡單的短代碼
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
6 l5 K3 Q/ _+ U( W" N$ S: L+ ]+ e9 y! o

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
  g2 I8 G- q, Y

• 建立一個函數 , 當 wordpress發現短代碼時會呼叫此函數 ;
• 藉由設置一個唯一的名稱來註冊短代碼 ;
• 把註冊的函數連結到wordpress的action上。
  % w) s/ |& u' ], \" K, e

本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
2 T0 Y1 x% ]: L2 i' H% l1.1 建立返回函數
. m9 D. f; s+ g9 d  F" X: d( U" ^當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。

1. function recent_posts_function() {
   - k! m% S/ T  C; }6 b7 ?( p
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   & H% ^) u) K' ~* b3 P4 a' k
3.         if (have_posts()) :
   1 A- F9 t/ B1 e; q  w$ ~, J9 }+ b
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   & g' e: p) P7 S8 H5 L6 B
6.                 endwhile;
   + ~& A. d' t6 ^4 j. }, {
7.         endif;
   - N& o# Y' N9 S7 ^: i9 V% ^" m: a
8.         wp_reset_query();
   
9.         return $return_string;
   
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
; R2 k9 ]7 T2 J
6 j5 p% ~6 P: h
1.2 註册短代碼
現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   2 G5 t9 y' S# g2 s' I
2.         add_shortcode('recent-posts', 'recent_posts_function');
   ' l2 ~+ }! L: u
3. }

複製代碼

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

1. [recent-posts]

複製代碼

將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。
; D+ p. b: S! P  o, }4 ?6 [

1.3 Hook into WordPress

為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
& i# v' ^0 [! \$ @5 E5 f& g: I

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

複製代碼

1.4 測試短代碼
' m/ P/ P/ R+ w' {簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   . \% F/ X" b3 R4 M9 \% Y0 w
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   ; |9 K/ x& D0 E. V4 T/ \0 I: q& r
4.         ), $atts));
   
5. 
   9 k0 t1 x! p- m! W7 h" x1 T$ U
6.         $return_string = '<ul>';
   ! Q9 u/ T9 {# @: g$ {$ O
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
8.         if (have_posts()) :
   0 w$ M2 @- t  Q2 w* f6 c$ p9 f9 e
9.                 while (have_posts()) : the_post();
   
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    $ K% ?) F( g0 X3 ^' B3 M
11.                 endwhile;
    
12.         endif;
    ( v6 c4 M) y5 M- d; y, `
13.         $return_string .= '</ul>';
    : H3 x7 i+ ]; a3 s# M/ q
14. 
    
15.         wp_reset_query();
    9 m- v# k: S& J& f
16.         return $return_string;
    
17. }

複製代碼

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

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

複製代碼

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

9 v) M: L) O0 X3 F$ V8 U- p2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   7 P' Z0 Z7 V+ y2 K# t
2.         extract(shortcode_atts(array(
   - }; s3 }( S- E8 l. V; F# o
3.                 'posts' => 1,
   
4.         ), $atts));
   ) w) H7 f) R, B& j
5. 
   - s$ i5 W6 f/ i
6.         $return_string = '<h3>'.$content.'</h3>';
   " G+ U) X8 @5 L' i" @
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>';
    
12.                 endwhile;
    / N' |$ R: u* ^" n
13.         endif;
    9 \( d9 t  N# l% s- o
14.         $return_string .= '</ul>';
    ) x& Y( {3 o) G2 i* `" G7 ~
15. 
    
16.         wp_reset_query();
    % X' ?' R& Z# h3 t
17.         return $return_string;
    8 t1 E$ w3 l# h# g/ I: B. @, @
18. }

複製代碼

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

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

複製代碼

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

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

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

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

2 U4 g' e' ~! ~, ?4 @3 N

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

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

複製代碼

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

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

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

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

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  5 ^6 F  ]& C8 q& z; _

4 |: o6 z8 s8 x7 J* n! E9 [' o4.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', {
   
3.                 init : function(ed, url) {
   
4.                         ed.addButton('recentposts', {
   1 L: A5 l1 o( {! d. I' C7 P
5.                                 title : 'Recent posts',
   
6.                                 image : url+'/recentpostsbutton.png',
   ( u3 e9 S/ U: d$ t
7.                                 onclick : function() {
   / T/ l& j/ d; e' N( |6 z) R6 g
8.                                         var posts = prompt("文章數量", "1");
   3 h8 k1 M* @; W6 |+ T0 q2 T
9.                                         var text = prompt("請填入列表標題", "最新文章");
   
10. 
    ( z7 w+ ^) z  R3 w$ ~3 D* C+ J+ w
11.                                         if (text != null && text != ''){
    
12.                                                 if (posts != null && posts != '')
    
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    . \1 ^. [, h$ M) o
14.                                         else
    6 r( a5 ^3 [3 \& s( o% V$ \6 A! P
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    
16.                                         }
    ; G" S, u' [' [
17.                                         else{
    1 [6 b; o5 h( c
18.                                                 if (posts != null && posts != '')
    
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    ; x7 j: c6 A5 H4 y4 V6 m
20.                                                 else
    4 T0 w! z* A, G5 E8 r9 n3 T
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    
22.                                         }
    
23.                                 }
    
24.                         });
    5 o  p7 }! G0 y+ x0 S! }7 h
25.                 },
    8 f" `, x7 v7 {& ^+ a6 G' M7 h
26.                 createControl : function(n, cm) {
    
27.                         return null;
    
28.                 },
    
29.                 getInfo : function() {
    , a' w" G& i3 h9 V
30.                         return {
    5 L- R: `( F+ Z/ |+ a
31.                                 longname : "Recent Posts",
    : y# h' |0 x; S! b
32.                                 author : 'Specs',
    
33.                                 authorurl : 'http://9iphp.com',
    
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    ) ?! ^7 W4 h5 L' t. O* U, S
35.                                 version : "1.0"
    
36.                         };
    
37.                 }
    
38.         });
    4 a% @6 M0 D3 I& T$ I- L  @& U7 p" {
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    0 f3 b5 {; S$ V1 ?6 M
40. })();

複製代碼

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

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

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

7 W+ k5 n% W3 E& H" d. m9 b% C

4.2 註冊按鈕及TinyMCE插件
4 e5 R1 e& H2 V! W2 ?6 ]" [

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

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

1. function register_button( $buttons ) {
   5 N+ y2 @3 b  d* ^! d/ l
2.         array_push( $buttons, "|", "recentposts" );
   4 L" o4 q6 o8 d* b+ O7 \% r
3.         return $buttons;
   " E: c: o; s. J' t! N% r
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
! g) L. ]5 o9 m- l: f

1. function add_plugin( $plugin_array ) {
   , N% E, {7 G- Q9 s2 w' w8 _
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 過濾器，當載入按鈕的時候執行。
6 i5 c/ i! r5 `6 ]) g1 b! X9 ]3 l

1. function my_recent_posts_button() {
   ' K9 r* E* u- Q! Q. o9 G
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   ! t/ d' K) F5 A, u5 b5 l4 [
4.         }
   
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   $ Y- Z' L- e5 ?& C+ W
8.                 add_filter( 'mce_buttons', 'register_button' );
   3 L% u7 J! q+ |5 x% a6 i
9.         }
   5 O$ m% F, T. H8 O8 s
10. }

複製代碼

當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
% q& V# z( E  Z2 w: f6 n最後把函數勾到Wordpress初始化函數

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

複製代碼

4.3 按鈕的用法

- `; P7 v( ~1 [+ o. @

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

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

9 K: O! f6 I6 @/ e) g* S# c

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

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

8 k% L7 m. j6 ?* u0 Q! ?

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

參考文章: 1 2