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

IT_man

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

, q4 ^" U% g- C6 H0 C, _, awordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
以下是 wordpress 短代碼的詳细介紹及進階應用。

$ a# H1 t  y) T8 z3 g2 q$ z/ d) u7 d短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
5 _, w' }1 h+ T

1. [recent-posts]

複製代碼

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

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

複製代碼

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

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

複製代碼

8 C1 o* |: I& d' T! @; m$ m1. 簡單的短代碼
8 O0 l! [4 }/ C, U/ i+ D/ `本教學的第一部分 , 我們會建立下列短代碼的程式碼 :

1. [recent-posts]

複製代碼

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

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

本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
1.1 建立返回函數
! Q( {& t& W( F9 y% M當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。

1. function recent_posts_function() {
   ( i8 p- v& T& C( A2 ?5 G5 ?! a
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   + M4 k- P; }4 v/ r# j0 |8 X, a4 O
3.         if (have_posts()) :
   
4.                 while (have_posts()) : the_post();
   ( ~; y7 o( @6 s& V4 n4 C
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   
6.                 endwhile;
   ( K/ U8 M" i3 c; L0 W8 S# L2 N) y
7.         endif;
   
8.         wp_reset_query();
   
9.         return $return_string;
   + S7 }4 }! T, P/ f+ y" E
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。


1.2 註册短代碼
現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   , F4 f) {% a$ p
2.         add_shortcode('recent-posts', 'recent_posts_function');
   1 f9 l# x$ @$ W1 ^5 [+ A
3. }

複製代碼

當在文章的內容中使用短代碼
. J/ [. K  L- D$ l/ ~# y8 N

1. [recent-posts]

複製代碼

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


3 P- `" F$ I# D! O- y1.3 Hook into WordPress
% O! k, B3 g8 @1 d
5 o( n; W5 [, G; c+ A. _為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
: J7 O4 v1 X7 R. N. o% B

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

複製代碼

5 u& T, g" h$ ]! k5 X" z6 K1.4 測試短代碼
簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   9 g! i4 J0 T* o9 ?; h
2.         extract(shortcode_atts(array(
   5 }: Y+ E9 w* P8 ]+ Z1 }( {3 D
3.                 'posts' => 1,
   1 V6 y7 S7 X. t% ?5 j: f, l- [
4.         ), $atts));
   3 n1 _$ |1 R, C
5. 
   9 D* X. L; h( M/ A/ o2 g. W  \  a8 j
6.         $return_string = '<ul>';
   
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    # c/ X4 \6 S- Q0 ]+ F# B
11.                 endwhile;
    * B6 r! w8 G4 y1 _
12.         endif;
    * K- _( h3 o% }: q- z# p
13.         $return_string .= '</ul>';
    * n! W5 B' |  k& ?
14. 
    
15.         wp_reset_query();
    & D, T$ k1 c, ~9 q
16.         return $return_string;
    
17. }

複製代碼

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

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

複製代碼

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

2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   / k( r; g$ T# p/ B& |0 w
2.         extract(shortcode_atts(array(
   . S- }+ a0 m0 A% B5 k
3.                 'posts' => 1,
   
4.         ), $atts));
   
5. 
   
6.         $return_string = '<h3>'.$content.'</h3>';
   
7.         $return_string .= '<ul>';
   
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
9.         if (have_posts()) :
   ) P# B; ^) \( r) u
10.                 while (have_posts()) : the_post();
    
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    6 g0 V3 D; o  B2 \
12.                 endwhile;
    
13.         endif;
    
14.         $return_string .= '</ul>';
    , }. u4 P, `% P  @$ U
15. 
    & A# r0 {6 b8 K, Y4 G( {7 D4 {
16.         wp_reset_query();
    6 Q) A5 t8 t  a4 }; h+ X
17.         return $return_string;
    
18. }

複製代碼

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

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

複製代碼

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

" [$ c% k/ H7 u2 \0 P+ X$ f$ m

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

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

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

* p) ~: l6 i) J

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

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

複製代碼

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

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

4. TinyMCE編輯器增加短代碼按鈕
6 r7 k0 }  |" j1 V* `$ o
5 J2 D: z; e( @4 b0 m雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類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() {
   5 {" X8 g5 i- ?9 b) z" ?7 v& Q2 O
2.         tinymce.create('tinymce.plugins.recentposts', {
   
3.                 init : function(ed, url) {
   
4.                         ed.addButton('recentposts', {
   2 `7 x! V2 E  s: ?) P2 @! I' x
5.                                 title : 'Recent posts',
   ( Y: b% p3 X( G6 M: v0 Q& H7 G
6.                                 image : url+'/recentpostsbutton.png',
   
7.                                 onclick : function() {
   
8.                                         var posts = prompt("文章數量", "1");
   9 G0 U" ~2 O8 w
9.                                         var text = prompt("請填入列表標題", "最新文章");
   
10. 
    ; n0 \" P+ c% L7 @0 Y  I. T! g
11.                                         if (text != null && text != ''){
    
12.                                                 if (posts != null && posts != '')
    
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    1 h+ I7 ~1 U* _3 f% d, k
14.                                         else
    : k+ E" f2 b5 d( b) u
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    # T6 v- m7 D. `+ p" e4 P8 Y
16.                                         }
    
17.                                         else{
    
18.                                                 if (posts != null && posts != '')
    
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    5 K' p% u) G/ U2 p4 O! U" U) S
20.                                                 else
    3 j2 q, x" o( Q
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    . _8 l2 X/ d3 U, y" K' q7 Z
22.                                         }
    + f, J. W: u6 G" R% D
23.                                 }
    & C5 b' j3 z5 P$ O
24.                         });
    
25.                 },
    % ^  V$ ]6 u& g& g7 F7 [
26.                 createControl : function(n, cm) {
    4 s4 p7 k  y) S8 ]% [4 ^+ j, Z
27.                         return null;
    & C; j$ `) }) w" Y8 V, {' `
28.                 },
    
29.                 getInfo : function() {
    
30.                         return {
    
31.                                 longname : "Recent Posts",
    % |7 N# J2 t8 Y$ ?7 w! r& t* q5 B
32.                                 author : 'Specs',
    
33.                                 authorurl : 'http://9iphp.com',
      P7 P" F, I4 F/ I. U
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    6 M- t; d9 o( ?, x0 i) R& P8 P
35.                                 version : "1.0"
    
36.                         };
    
37.                 }
    / T# j  Z( h, @& K- ~
38.         });
    
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    8 O9 g) H6 g9 o% c& g9 C5 h
40. })();

複製代碼

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

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

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

, K7 q$ c2 C0 q, @

4.2 註冊按鈕及TinyMCE插件

2 b+ F* `9 _- A: w* T, |

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

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

1. function register_button( $buttons ) {
   
2.         array_push( $buttons, "|", "recentposts" );
   1 d+ B/ U4 m! H4 h2 x
3.         return $buttons;
   
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。

1. function add_plugin( $plugin_array ) {
   
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   $ p0 B2 U# U+ P1 S" u" k
3.         return $plugin_array;
   7 y) l! \* W% G# `3 j
4. }

複製代碼

下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。
3 c% l/ d3 k( ^8 A) ?5 m9 l

1. function my_recent_posts_button() {
   
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   & q1 F7 z7 A' F5 l' ]2 c' ?: u" J3 O
3.                 return;
   
4.         }
   
5. 
   , E4 F, C& f$ G( D
6.         if ( get_user_option('rich_editing') == 'true' ) {
   : K/ j2 ?0 z  k
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   # Q1 s) ?+ e4 G5 g9 F8 A
8.                 add_filter( 'mce_buttons', 'register_button' );
   
9.         }
   " n  H8 R! W6 r' l" n8 C
10. }

複製代碼

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

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

複製代碼

% @% n9 ]! U  N( l1 F* ]4.3 按鈕的用法

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

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

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

( v" t& c) K) N0 v6 y( ?" k9 \

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

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

參考文章: 1 2