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

IT_man

WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
* M" a5 M: b; n! E5 q1 w. s" U
wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
以下是 wordpress 短代碼的詳细介紹及進階應用。
  K' D# P& X, k5 ^3 \/ Q
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
( M7 C  d3 u8 i) P3 u$ k, H

1. [recent-posts]

複製代碼

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

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
$ k0 |$ S7 d+ w

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

複製代碼

1. 簡單的短代碼
8 \, p1 q9 @% W& @# P3 y本教學的第一部分 , 我們會建立下列短代碼的程式碼 :

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :

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

本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
. D. G& H: ~0 Y, ~8 E  R. u1.1 建立返回函數
  |3 Y9 C- }( y( ?3 N當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。

1. function recent_posts_function() {
   2 h) F: U, m9 L' S% n' r, H
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   ) o; W1 U2 \, V9 ]; ~
3.         if (have_posts()) :
   * {( C  W. z% X9 b
4.                 while (have_posts()) : the_post();
   ' y5 X8 r' q6 U; J7 o. O: c) ~* s
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   * b  i6 X% _5 _, d, C
6.                 endwhile;
   ( U( n7 y' x1 ~- G
7.         endif;
     Y* M1 g) K7 G; L
8.         wp_reset_query();
   5 _7 v# W2 K+ d& w0 l- g! m9 e
9.         return $return_string;
   # ^1 h3 D  J7 n( L
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
8 v1 q/ B8 k/ {& x# {
! U2 [4 h0 a+ t7 ]" @
2 l6 y. Z1 t* O! P1.2 註册短代碼
3 h: j2 b- t' ~: q- B現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   . e+ O' B0 Y3 ~; K" h+ C
2.         add_shortcode('recent-posts', 'recent_posts_function');
   ( l: Z# z% t/ }3 h
3. }

複製代碼

當在文章的內容中使用短代碼
. K" z2 q8 R/ b

1. [recent-posts]

複製代碼

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

2 D0 m% I  k' M8 {# l; x8 _  p1.3 Hook into WordPress

# x' P8 @3 T* U為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
! ~  H) G6 Y, r) R, Q

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

複製代碼

" C  }% F; C+ J1.4 測試短代碼
. \) f. d7 p$ T# l. N' [! k簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   
2.         extract(shortcode_atts(array(
   * U3 v0 I; W* g( T4 D" e  G$ X
3.                 'posts' => 1,
     x1 Z4 H" Y# Z) g/ o3 j* ^. [
4.         ), $atts));
   
5. 
   
6.         $return_string = '<ul>';
   ; o. s4 w% ~* n' S
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   5 k- ?1 W- j1 N( j$ [' _, R6 Y) M
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   4 x! d, r$ Z. [* E: p: i+ V
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    % k; `( ]* u" q; T7 o
11.                 endwhile;
    & ?* ^8 t) F. c6 Y$ c+ M1 m8 K( Y
12.         endif;
    7 m6 q8 y- u1 R8 e5 t5 y
13.         $return_string .= '</ul>';
    5 T) _7 v) f, l9 H# ~! u8 E
14. 
    9 Z- K8 z/ P! C# e
15.         wp_reset_query();
    
16.         return $return_string;
    : A, H+ |% p! c- T4 V" H9 Q
17. }

複製代碼

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

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

複製代碼

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

$ [8 r9 c9 f3 q7 _% ^. R2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   ! h* y# a! o" U# N% F+ P5 ^
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   
4.         ), $atts));
   
5. 
   
6.         $return_string = '<h3>'.$content.'</h3>';
   " c7 b, X8 }0 e2 S- S% h
7.         $return_string .= '<ul>';
   6 j$ w1 V. n4 f! B. B2 W& k
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
     G+ b* _0 H/ G+ B8 w8 m
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    7 q" |6 p1 {; S* n( Q; G
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
12.                 endwhile;
    
13.         endif;
    5 H5 s8 \  J" Q5 t: R
14.         $return_string .= '</ul>';
    2 |9 u5 e& x, l3 X, r
15. 
    3 M' w8 l3 \% X. p. c  v1 q
16.         wp_reset_query();
    0 u0 V+ J8 F+ l1 h3 ~
17.         return $return_string;
    5 G; J4 ]- m. H
18. }

複製代碼

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

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

複製代碼

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

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

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

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

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

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

複製代碼

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

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

4. TinyMCE編輯器增加短代碼按鈕
  }  W: v6 G2 k2 c0 f3 B8 f$ F
雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類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 @9 z$ J. O8 E9 O1 \
5.                                 title : 'Recent posts',
   
6.                                 image : url+'/recentpostsbutton.png',
   % _# S5 Z% q2 j
7.                                 onclick : function() {
   
8.                                         var posts = prompt("文章數量", "1");
   
9.                                         var text = prompt("請填入列表標題", "最新文章");
   . S# {% S/ K5 l% _# a: \; k% N
10. 
    $ S. `4 B! F7 w# x( s4 G% k) K7 c
11.                                         if (text != null && text != ''){
    9 `  o* l8 F" w
12.                                                 if (posts != null && posts != '')
    ! R5 H9 P: F) w
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    
14.                                         else
    0 s) o( }4 I' ^8 G7 N" z
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    + i% R/ b3 @# K4 T# k1 @: t( O
16.                                         }
    
17.                                         else{
    & v0 K; ~7 c( P, z3 _
18.                                                 if (posts != null && posts != '')
    9 y! _8 K8 _9 \! }; p, Q2 e) |
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    
20.                                                 else
    
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    
22.                                         }
    ( B2 p' e1 f: N
23.                                 }
      b) a$ e) ]  n; r! W7 b
24.                         });
    
25.                 },
    
26.                 createControl : function(n, cm) {
    
27.                         return null;
    
28.                 },
    
29.                 getInfo : function() {
    
30.                         return {
    
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    4 A6 [3 l0 p3 |" D! |
33.                                 authorurl : 'http://9iphp.com',
    
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    
35.                                 version : "1.0"
    $ r  j% m$ A, r
36.                         };
    
37.                 }
    
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 ) {
   & e) e! _! t; }6 c5 k# r  s- `
2.         array_push( $buttons, "|", "recentposts" );
   4 y6 f" B+ l' }1 j
3.         return $buttons;
   2 d2 m& v4 y5 k6 [  G$ z4 ~$ {
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
+ b" @% p' K9 ?. d# P( c0 ^

1. function add_plugin( $plugin_array ) {
   1 X* }/ o9 D( m' d
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   / `4 {$ {8 e2 r
3.         return $plugin_array;
     n$ r9 {# h. Q' {
4. }

複製代碼

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

1. function my_recent_posts_button() {
   6 T/ m0 Q  w1 ~2 I/ y% j& w
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   % ?$ i0 B3 o! Q& N8 m7 D
3.                 return;
   ( ]% b; d1 a$ d8 g; R, t# H4 e: G
4.         }
   4 S4 G9 ]0 E  x) i
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   * e4 S. z+ ]. ^+ [' t% o( x
8.                 add_filter( 'mce_buttons', 'register_button' );
   * f$ ]9 d3 B: s9 a* }7 y5 L& z
9.         }
   
10. }

複製代碼

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

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

複製代碼

4.3 按鈕的用法

  T. M( `, ^2 q  l1 y! a

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

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

& e# {5 n' h8 a+ @0 Y* y

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

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

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

參考文章: 1 2