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

IT_man

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

  ~8 n5 A+ K$ k& D" I: Zwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
以下是 wordpress 短代碼的詳细介紹及進階應用。
3 N' x& c  t8 o
1 c# N0 X$ n, s  Z6 @' o. e+ b短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
9 Q* l+ L( V9 Y6 h" i

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
; V( A. P' z8 g9 V$ y

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
8 ~5 a( S! @6 p0 v; ^) ~4 h* a

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

複製代碼

4 q: X& t- L6 R
1. 簡單的短代碼
$ w/ Q. x6 Y+ F$ }本教學的第一部分 , 我們會建立下列短代碼的程式碼 :

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
) E+ I- K6 h1 h" u8 C

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

& K& y: w7 K6 p, j. x4 ?0 H6 P本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
1.1 建立返回函數
1 d) L: h- B* c6 A* a+ F當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。

1. function recent_posts_function() {
   - p( r: q+ `+ n& M& a/ c
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   + \0 [7 j( A$ o2 D
3.         if (have_posts()) :
   ; g  Q. T+ W+ t
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   ; ]& [, N, q  c3 u' \' H) D" o* j
6.                 endwhile;
   
7.         endif;
   
8.         wp_reset_query();
   2 r$ _$ y: ]# H
9.         return $return_string;
   8 n3 C- ^! d. a2 S3 H0 e
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
* I' T) b) K  m
, h9 \: B! N8 F, w
/ n" n4 h6 t& H4 v  K* q1.2 註册短代碼
現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   8 }% _$ q: }7 ?# h* ^
2.         add_shortcode('recent-posts', 'recent_posts_function');
   & S# u, p- E! }% d5 F- R& T
3. }

複製代碼

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

1. [recent-posts]

複製代碼

將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。
% n( t! ?$ m& l  H! y( A7 C

1.3 Hook into WordPress
) D. U, X& C2 b1 Q  j0 q
為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。

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

複製代碼

1.4 測試短代碼
( D: q' W' P' w% f4 u' ]4 X簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   
2.         extract(shortcode_atts(array(
   3 z8 {  w$ u2 Y- L  b( N1 D, S
3.                 'posts' => 1,
   2 e9 X- T' D, y$ X. z. Y
4.         ), $atts));
   ; w) E# N1 x2 L; a) |8 V6 {
5. 
   4 k3 ~/ T; V5 J2 L( d% c1 f
6.         $return_string = '<ul>';
   2 d4 p  Z, e4 U& k$ G% k7 n
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   . j8 T/ P6 G8 m: M3 M' k$ o7 ]
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   8 P4 {# M* \1 x( X$ C" n1 `! |& p
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    & Z6 |# y) ?7 ~" b$ g2 g8 [6 z* K
11.                 endwhile;
    
12.         endif;
    
13.         $return_string .= '</ul>';
    3 X( }/ q% s* `" Q! ^8 ]
14. 
    
15.         wp_reset_query();
    ! N4 u: B$ b/ C: T5 ]
16.         return $return_string;
    % n; n. C, W2 M4 h/ T% q0 d7 z( \+ q
17. }

複製代碼

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

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

複製代碼

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

2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   
2.         extract(shortcode_atts(array(
   " j+ |( Y* G+ `/ S+ u7 ]$ a
3.                 'posts' => 1,
   
4.         ), $atts));
   
5. 
   8 {2 E3 m5 }& D- M/ Q/ g& c" s
6.         $return_string = '<h3>'.$content.'</h3>';
   4 \' {# e$ G( }+ Q$ G% ?8 _; t: m/ V
7.         $return_string .= '<ul>';
   ! x, h1 O) N9 D
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
9.         if (have_posts()) :
     n) c4 k, u# S
10.                 while (have_posts()) : the_post();
    
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    ! _5 P" ?& G- M  o  l
12.                 endwhile;
    . g9 Z- D. I; u) e8 E
13.         endif;
    $ k1 n' p) V7 c. ~
14.         $return_string .= '</ul>';
    * r1 q, ]8 @4 ^! m
15. 
    
16.         wp_reset_query();
    
17.         return $return_string;
    5 M3 b1 f+ S7 k6 m6 b( I
18. }

複製代碼

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

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

複製代碼

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

1 f6 W, ^0 {1 z6 ?

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編輯器增加短代碼按鈕
. _- T2 `2 |2 `/ d, ]
( X0 u1 j. h  M1 r' h& |0 Y& s雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  3 R6 z" }7 Z, B- W

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) {
   7 w+ ~! ?9 K8 p6 C9 Q
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   / J" N# D+ u# X2 W
6.                                 image : url+'/recentpostsbutton.png',
   . K" e* i8 D5 P. j% J
7.                                 onclick : function() {
   9 O! H3 j& {/ @3 M& s, B6 K6 [4 K
8.                                         var posts = prompt("文章數量", "1");
   
9.                                         var text = prompt("請填入列表標題", "最新文章");
   
10. 
    5 R! z9 k0 u7 t9 |9 M
11.                                         if (text != null && text != ''){
    5 |# `" p) I7 |8 C
12.                                                 if (posts != null && posts != '')
    5 m9 \/ i& M, B6 ^; X' J% x
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{
    8 S4 z% c! G. P! @  N
18.                                                 if (posts != null && posts != '')
    ( A! e( ^' j: f
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    
20.                                                 else
    * {& F, @) e% E
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    
22.                                         }
    # ^% B; i$ M* N5 ~+ k# X" G
23.                                 }
    5 q! _' L  X  _% I1 u+ o1 \
24.                         });
    5 \$ M  q3 t1 k
25.                 },
    
26.                 createControl : function(n, cm) {
    % K# M5 V# [; Y0 t* A2 Q$ u
27.                         return null;
    % i2 _$ v4 T5 m3 b9 `  ]" w
28.                 },
    , w6 }4 H1 A$ U  y+ g
29.                 getInfo : function() {
    . e+ J/ {; \( ~* N
30.                         return {
    
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    4 s- v$ z: z/ P, S8 u
33.                                 authorurl : 'http://9iphp.com',
    
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    
35.                                 version : "1.0"
    0 ^. d2 `9 v  j2 `: z7 J0 {
36.                         };
    
37.                 }
    
38.         });
    8 R3 ]9 u  X) Z6 @0 E
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    
40. })();

複製代碼

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

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

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

8 O; ~) m5 {2 W& N) P) p

4.2 註冊按鈕及TinyMCE插件
% Y1 _- u, r: k& z! F4 b; u

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

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

1. function register_button( $buttons ) {
   : m4 f0 J' @, r* o" c4 @, P
2.         array_push( $buttons, "|", "recentposts" );
   4 k! ]! F: T- p$ S
3.         return $buttons;
   ! Z% j; ]. H4 k+ W) y
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
) \" r) h" P; \- T& ?

1. function add_plugin( $plugin_array ) {
   
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 過濾器，當載入按鈕的時候執行。
3 N* A# W( \* u- h& d$ g$ m" N

1. function my_recent_posts_button() {
   * w* X% i% k; L4 ]) t8 \
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   
4.         }
   # L9 t5 p- a0 V+ k3 [
5. 
   . v$ O, A  S$ }/ k/ ?: e2 V; V! |
6.         if ( get_user_option('rich_editing') == 'true' ) {
     a. H& I  F5 v$ H
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   * b- K4 E9 t( u; {6 g
8.                 add_filter( 'mce_buttons', 'register_button' );
   
9.         }
   
10. }

複製代碼

當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
0 z( G) y1 M2 q" z0 {# T. C! X最後把函數勾到Wordpress初始化函數

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

複製代碼

4.3 按鈕的用法

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

8 F1 t1 q' X& [( B0 ]+ Q

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

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

+ Y# k7 g0 d5 C. B

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

9 F6 P+ W: h$ H* W  ?) q0 e7 Y/ e! m

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

參考文章: 1 2