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

IT_man

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

9 x- _, G. ^* {: j) V! gwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
! R' I2 S  w1 W! t以下是 wordpress 短代碼的詳细介紹及進階應用。
5 X% W  c2 Q1 E" p2 u0 k" K/ L
8 x, j! \9 G2 e+ _6 C6 B短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
) W+ B# r1 t: f

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
* M9 B6 `9 ~- h# e" S1 Y

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

複製代碼

2 l1 E- _7 n! i$ w1 {: c1. 簡單的短代碼
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
' `; N3 d- i: @5 D  M9 c9 ~, k6 i) H

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
, E; ^5 C1 [$ o3 q9 s

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

9 Y: j( D0 [/ x9 s6 u3 ^本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
1.1 建立返回函數
2 r: i: Z' N8 E5 C+ c. U當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
6 g6 h) w- [0 j# e

1. function recent_posts_function() {
   
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   7 o& \% Z. E4 M9 D2 W  F7 C
3.         if (have_posts()) :
   
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   & a. c% T% u9 O' q0 x: Q- G9 D" i
6.                 endwhile;
   3 T7 |7 j$ e+ l) D# ~
7.         endif;
   
8.         wp_reset_query();
   
9.         return $return_string;
   5 l! Q. _3 Q0 ]1 c
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
7 H: g( }8 w/ ]9 d
3 ^) X) s$ |, l( J: _# u3 j3 @
! G2 R, M* {; v( d# I6 M- K( h1.2 註册短代碼
現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   
2.         add_shortcode('recent-posts', 'recent_posts_function');
   $ N8 Z+ Z) I$ G; W- K! R
3. }

複製代碼

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

1. [recent-posts]

複製代碼

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


1.3 Hook into WordPress
) m  H: K" Q8 a
為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。

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

複製代碼

$ \0 T# q8 A4 m* c1.4 測試短代碼
+ [" E% s( }& j! K' e5 }簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   0 f! E/ R! g$ f; C. ?. C8 I
2.         extract(shortcode_atts(array(
   $ R2 V5 ^2 h: Y( f5 b) M
3.                 'posts' => 1,
   
4.         ), $atts));
   
5. 
   / O$ S' w1 t% d+ N- n8 C% Z0 c
6.         $return_string = '<ul>';
   & z- q9 r5 C& N0 J0 j% A$ D
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
8.         if (have_posts()) :
   , N# r' t  \# Y4 P$ |" Q; V0 {
9.                 while (have_posts()) : the_post();
   
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    ; \9 y- I- ^4 s0 v/ N" i$ L
11.                 endwhile;
    
12.         endif;
    & |/ B; a0 C' z; L
13.         $return_string .= '</ul>';
    7 b6 i0 ^7 Y5 u7 G4 F
14. 
    
15.         wp_reset_query();
    
16.         return $return_string;
    7 a) o6 O. Y& Z
17. }

複製代碼

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

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

複製代碼

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

$ g" `, u' z! V1 p7 u2 I: O6 p- H2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   
2.         extract(shortcode_atts(array(
   $ ?: L! d% k+ C5 Z: E6 G. @
3.                 'posts' => 1,
   
4.         ), $atts));
   " x/ H9 u7 |# b2 A2 P6 r
5. 
   ) u: ]8 N* B0 l: n9 ~& O6 @
6.         $return_string = '<h3>'.$content.'</h3>';
   
7.         $return_string .= '<ul>';
   
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    * c& U4 T2 F+ V
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
12.                 endwhile;
    
13.         endif;
    ) y% X- @- D7 P) u. \
14.         $return_string .= '</ul>';
    
15. 
    
16.         wp_reset_query();
    
17.         return $return_string;
    : U/ ]! W$ D; A+ @1 R; n+ x7 j; Q
18. }

複製代碼

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

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

複製代碼

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

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

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

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

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

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

複製代碼

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

: n- |- o1 m. G: a2 ~0 Y

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

4. TinyMCE編輯器增加短代碼按鈕
& |, c1 e8 C7 }- i+ ^2 c9 X
雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類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() {
   ( d+ e, H6 f5 N& F; Y1 K1 j
2.         tinymce.create('tinymce.plugins.recentposts', {
   
3.                 init : function(ed, url) {
   / {( Z5 z9 `  @2 `
4.                         ed.addButton('recentposts', {
   * ]/ W, v+ E1 j  ?
5.                                 title : 'Recent posts',
   6 A+ X) b1 a+ s1 R" O6 I1 e3 e
6.                                 image : url+'/recentpostsbutton.png',
   4 w, \: \: t; \6 y; q
7.                                 onclick : function() {
   
8.                                         var posts = prompt("文章數量", "1");
   : y1 h5 `: c( C  T2 `
9.                                         var text = prompt("請填入列表標題", "最新文章");
   8 K& M( [1 O. h% A( _+ Y
10. 
    , U7 g4 J& V" |  A; k0 v) h! P# t
11.                                         if (text != null && text != ''){
    
12.                                                 if (posts != null && posts != '')
    1 a6 i6 S* C$ O6 c0 I9 d
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    % N" S; g# e2 V2 Q3 g
14.                                         else
    - K( c8 P& e  y- N( ~$ x$ ^, y
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
      _2 D3 G# _4 d$ ~: t+ v
16.                                         }
    
17.                                         else{
    7 n) K: Y/ d% [, V" t+ ~0 R) O& k$ @
18.                                                 if (posts != null && posts != '')
    " M9 g0 T# _- w/ v9 b
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    
20.                                                 else
    
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    
22.                                         }
    5 U1 ]  p6 N& N# Q- k
23.                                 }
    1 C: p& V* ~7 U
24.                         });
    : ^* s$ e8 Q" D7 m  H% ]# y
25.                 },
    9 c- x% s: ]9 X9 t
26.                 createControl : function(n, cm) {
    
27.                         return null;
    ; e) A2 t0 `& ?
28.                 },
    
29.                 getInfo : function() {
    
30.                         return {
    + Q" }9 Z' v/ A! D) G
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    
33.                                 authorurl : 'http://9iphp.com',
    4 B& M; @* t" v$ d! }$ R
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    ; y; x  J# }) h/ E; b: c
35.                                 version : "1.0"
      t) S7 F2 ?$ W
36.                         };
    ) V# `" V% G/ I
37.                 }
    3 |6 ?$ |( \! ?6 n; @
38.         });
    
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    
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 ) {
   
2.         array_push( $buttons, "|", "recentposts" );
   , C2 T( N2 b' i/ A
3.         return $buttons;
   
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
2 }( w/ F6 V8 D

1. function add_plugin( $plugin_array ) {
   
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   
3.         return $plugin_array;
   * Q# p* R% \8 f' `( s# U( g
4. }

複製代碼

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

1. function my_recent_posts_button() {
   / m, W& `0 T7 I
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   / D9 X' O& S# c( r* y
4.         }
   ( A9 |* x8 J& s& i
5. 
   - P& L! L  z0 {) C9 s; P
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   
8.                 add_filter( 'mce_buttons', 'register_button' );
   ( P8 j/ v9 i! k" h
9.         }
   
10. }

複製代碼

當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
) p6 V8 n! f+ U9 B% T. [' i; Z最後把函數勾到Wordpress初始化函數

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

複製代碼

. f! q; w( K( E( H4.3 按鈕的用法

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

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

5 j' Z$ V  ^$ G! [- G

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

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

/ c! l- P4 c5 b! g, `; b

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

參考文章: 1 2