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

IT_man

WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
0 M' D; F9 B3 `. g
, ]3 M& t  l2 X- c6 o" B/ Hwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
( {( M! q; W! l! w9 Z$ Z以下是 wordpress 短代碼的詳细介紹及進階應用。
+ q4 O" f' W; Z" {+ m( X) E2 V  y
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
/ D) |: Z# M% B

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

複製代碼

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

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

複製代碼

( f" r4 o$ w. \1. 簡單的短代碼
! T# W2 J; t' [' `4 F/ ?本教學的第一部分 , 我們會建立下列短代碼的程式碼 :

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
5 `; s1 Q7 ^: I& M: b/ ~6 V

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

3 ?) X2 Z5 {) S: r, u# v/ B3 s6 p2 s本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
  M) t) y7 r6 [' c6 a9 B/ b, U2 i) ^1.1 建立返回函數
0 G( \3 v. |# o( A& o/ i1 U$ a當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。

1. function recent_posts_function() {
   2 w& o& b; i/ f3 x6 z! i% k
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   
3.         if (have_posts()) :
   ' Q7 l% U+ X& E7 B! [; @: p. ~
4.                 while (have_posts()) : the_post();
   ! P# A! a' u: g
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   
6.                 endwhile;
   * y2 k& K& r. n6 z
7.         endif;
   
8.         wp_reset_query();
   # `' {; z" o, G0 w
9.         return $return_string;
   
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
: S3 C, `' {0 W( l- s

/ {. x, v- i: G# q4 F$ Y7 M1 B, X; ]1.2 註册短代碼
6 H" q0 S! R. N1 L現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   : u& ?7 l3 o: e% k' x6 R
2.         add_shortcode('recent-posts', 'recent_posts_function');
   
3. }

複製代碼

當在文章的內容中使用短代碼
# i4 [$ F# e  d% z" h9 c* C* f

1. [recent-posts]

複製代碼

將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。
& B/ V; `4 l5 k/ m( i! K

) B, Y% s6 ]1 c6 \" a1.3 Hook into WordPress
+ k8 u1 u) b* k0 C: M% S- q
* m2 m& l" W. n為了能夠執行 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){
   4 h5 |3 e, y, O7 Y1 r7 {
2.         extract(shortcode_atts(array(
   ) P- c4 \% R7 y+ ^
3.                 'posts' => 1,
   , o8 }& B, u& o3 b( K- N3 N" X4 m
4.         ), $atts));
   ) s! c2 u. a" |! `$ _9 S6 ?9 K
5. 
   1 n3 a" r1 g0 t/ w
6.         $return_string = '<ul>';
   . S/ }$ L6 R+ v* O0 Q1 F  M+ c' V# A
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   4 a. S2 H9 ^  O
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
11.                 endwhile;
    8 i8 {6 c, U( D: x& U
12.         endif;
    
13.         $return_string .= '</ul>';
    & u- y; p8 x5 l! n3 v9 G
14. 
    
15.         wp_reset_query();
    + s% o! ~+ f4 S* D" O0 h) Y( Y1 U
16.         return $return_string;
    
17. }

複製代碼

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

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

複製代碼

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

2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   ( ^% F& Z& q/ i& O" j+ a5 a& N" F
2.         extract(shortcode_atts(array(
   8 G, c+ d0 f, \- E/ n
3.                 'posts' => 1,
   
4.         ), $atts));
   ) r6 Y# X$ z; E5 F( P
5. 
   ) E+ O2 m: Q' w, W7 V
6.         $return_string = '<h3>'.$content.'</h3>';
   
7.         $return_string .= '<ul>';
   ( C+ L1 Z4 R  }! D* g& F4 G7 ?! h
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   $ X8 m! b+ |6 H1 L
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    0 k) B6 P' m' I0 Y9 q7 w: E
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    ; |0 `! R* f$ n/ c. k
12.                 endwhile;
    . Y0 z1 I/ h' l+ K, V
13.         endif;
    
14.         $return_string .= '</ul>';
    
15. 
    
16.         wp_reset_query();
    ) v& y6 M( f8 n  y
17.         return $return_string;
    
18. }

複製代碼

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

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

複製代碼

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

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

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

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

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

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

複製代碼

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

# s; C4 Z2 _" q1 O) V

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

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

4 K& e" ^# V# u! u雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類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() {
   
2.         tinymce.create('tinymce.plugins.recentposts', {
   
3.                 init : function(ed, url) {
   
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   
6.                                 image : url+'/recentpostsbutton.png',
   - ~: h+ D5 `7 {0 T% M- e
7.                                 onclick : function() {
   
8.                                         var posts = prompt("文章數量", "1");
   
9.                                         var text = prompt("請填入列表標題", "最新文章");
   
10. 
    ! F& j* q, a0 M8 M0 R8 F
11.                                         if (text != null && text != ''){
    
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]');
    
16.                                         }
    
17.                                         else{
    ' z2 ~/ g0 O! _
18.                                                 if (posts != null && posts != '')
    2 b  _. X* P' K9 E6 T6 A* n; H6 {
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    8 y8 K# |" T2 V* B7 X3 e
20.                                                 else
    9 u3 {/ S8 x' Z5 B
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    + ~2 D* T4 g# A
22.                                         }
    5 i% x+ |- V. v0 L7 A
23.                                 }
    
24.                         });
    / b4 Z! k& ?$ ]! R# v/ N
25.                 },
    ) `8 M7 y" B$ N# z5 I  y/ @9 \
26.                 createControl : function(n, cm) {
    0 h  {3 p. t: ^0 G9 c( A
27.                         return null;
    
28.                 },
    
29.                 getInfo : function() {
      D: ~3 I  B( l% C8 L  c
30.                         return {
    
31.                                 longname : "Recent Posts",
    - C: ^- D9 G8 l
32.                                 author : 'Specs',
    6 j+ }# X& }' T1 _. g
33.                                 authorurl : 'http://9iphp.com',
    $ F# l! @6 D2 u7 x
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    
35.                                 version : "1.0"
    
36.                         };
    & e& u( R2 r8 T3 c/ z+ }/ S9 \
37.                 }
    4 ?' }6 l/ J8 O, ^8 O9 W; ^: t
38.         });
    
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    9 q- `$ ~$ A$ D/ Q9 l9 H2 G
40. })();

複製代碼

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

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

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

# l4 s7 `& [5 G. D  s

4.2 註冊按鈕及TinyMCE插件
; f5 k; D: I: G8 X
% g8 c( [# w( h4 Q  y  z

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

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

1. function register_button( $buttons ) {
   * {) y. {5 Y- I- D% t8 I! f, O
2.         array_push( $buttons, "|", "recentposts" );
   
3.         return $buttons;
   
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
, S4 _$ \( M3 |' Y& t6 n

1. function add_plugin( $plugin_array ) {
   
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   
3.         return $plugin_array;
   5 x3 L; N5 s  ^0 P
4. }

複製代碼

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

1. function my_recent_posts_button() {
   
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   7 U) P! Q! f/ N
4.         }
   6 W$ `( D1 d$ t7 g( M0 p
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   ' K. {7 i! J- b: m$ b# w
8.                 add_filter( 'mce_buttons', 'register_button' );
   ! W9 N5 I! L4 ^  j( I
9.         }
   
10. }

複製代碼

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

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

複製代碼

4.3 按鈕的用法

  K- b6 w& x) d- l& u! j6 y

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

% }6 P! m" p* ]. W# q4 c7 ?

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

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

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

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

參考文章: 1 2