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

IT_man

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

7 j7 }! h4 }) X4 u* T5 N2 L) Rwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
/ J5 M* s2 ]4 r, Q( q, j! D以下是 wordpress 短代碼的詳细介紹及進階應用。
; {3 k3 f/ V1 b% }0 h
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
3 z3 x6 G2 j& b' \8 Q! m( @

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
# w8 F7 C; D/ j' u' }& H

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

複製代碼

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

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

複製代碼

% u' D2 e1 c# T
1. 簡單的短代碼
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
: _+ `/ u: A! N9 w0 E

1. [recent-posts]

複製代碼

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

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

3 c8 Q$ ]. @1 X7 N9 b/ d& |本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
: t0 S6 w7 Y. |3 R; E& N. v2 n4 d7 X1.1 建立返回函數
當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。

1. function recent_posts_function() {
   , o2 t- w: Y' w% d4 a
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   3 @5 k, z# I/ p2 I: @# U$ W4 M
3.         if (have_posts()) :
   
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   
6.                 endwhile;
   
7.         endif;
   6 [# z3 y& A0 j2 l
8.         wp_reset_query();
   4 P$ l3 L* k9 d4 y# @
9.         return $return_string;
   
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
) f" l1 w+ F8 q' Y$ n' g, ]

! f, `1 z6 x6 D1.2 註册短代碼
現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   
2.         add_shortcode('recent-posts', 'recent_posts_function');
   . i& e& B5 J' q1 J" o8 Q- E$ e  _
3. }

複製代碼

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

1. [recent-posts]

複製代碼

將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。
# a* p! X# E3 |5 b4 ^
, H$ {) E, G; p! P; j2 L& r8 k5 J% p7 u
1.3 Hook into WordPress
: a) K/ f% a5 P  L
: O+ F% A/ i  G8 l( Y/ I為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
$ ~: N3 t, y. d. H$ C. g

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){
   
2.         extract(shortcode_atts(array(
   2 [' w3 L# n& j0 M3 m, M8 Y
3.                 'posts' => 1,
   % V% V  |! w2 a! M7 A1 t- m3 r
4.         ), $atts));
   
5. 
   
6.         $return_string = '<ul>';
   4 y+ Z# Y& H1 u, X( X
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   2 v! k. D9 M$ Z6 l; b
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
11.                 endwhile;
    
12.         endif;
    
13.         $return_string .= '</ul>';
    
14. 
    
15.         wp_reset_query();
    8 r2 G8 ^) i- k7 ?/ W
16.         return $return_string;
    " z5 i4 M# F! \1 M- r% X
17. }

複製代碼

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

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

複製代碼

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

( J- r' c2 X0 o6 G+ T* ?2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   8 g" S2 t* a9 S: X8 a1 x3 o
2.         extract(shortcode_atts(array(
   8 }. E3 k( I/ i
3.                 'posts' => 1,
   , i4 `  u$ E; q4 y
4.         ), $atts));
   
5. 
   
6.         $return_string = '<h3>'.$content.'</h3>';
   7 [1 y5 Z  _9 `) Z
7.         $return_string .= '<ul>';
   ) \, {. [* d8 e; f9 d
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
9.         if (have_posts()) :
   - A0 ~, Y7 O- y& F4 Q) H6 C: ]
10.                 while (have_posts()) : the_post();
    ! Q) Y7 W$ F7 w
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
12.                 endwhile;
    2 ~8 N! c& |9 e. c7 \0 E$ ]$ T" U3 I
13.         endif;
    2 h9 I; X' `8 P
14.         $return_string .= '</ul>';
    
15. 
    
16.         wp_reset_query();
    
17.         return $return_string;
    
18. }

複製代碼

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

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

複製代碼

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

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

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

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

" x) C7 G! u' l

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

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

複製代碼

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

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

4. TinyMCE編輯器增加短代碼按鈕
1 a4 }) s  c8 r: \# D0 a, C
雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  0 Y* x& V3 d6 u6 r# X

4.1 透過JS文件來建立按鈕

JS文件是透過 TinyMCE API 來註冊 TinyMCE 插件的。我們在主題的 js 目錄下(/wp-content/themes/你主題名稱/js/)建立 recent-posts.js ，並貼進去下面的代碼（需要把按鈕圖片檔(/wp-content/themes/你主題名稱/js/recentpostsbutton.png)也放在同一個目錄）：

1. (function() {
     X7 ?1 a. N1 E( P3 }
2.         tinymce.create('tinymce.plugins.recentposts', {
   
3.                 init : function(ed, url) {
   / ]! N8 z- E) M- ]2 D& P0 a5 \* Q$ t
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   9 P& ], X4 @* j9 M( b3 H
6.                                 image : url+'/recentpostsbutton.png',
   
7.                                 onclick : function() {
   
8.                                         var posts = prompt("文章數量", "1");
   " V& n+ ]- F& a& ~
9.                                         var text = prompt("請填入列表標題", "最新文章");
     W# B/ a1 B3 l+ @( O/ _9 ~
10. 
    " V* R+ W" B* w9 y# O0 U  d1 y
11.                                         if (text != null && text != ''){
    
12.                                                 if (posts != null && posts != '')
    : U. U5 U) s  r+ p* Y1 P, K4 ?
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    . Z3 d/ o& _" _. r8 H
14.                                         else
    - t2 ^: z1 f% V
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    
16.                                         }
      H; `. V; ]/ D  W
17.                                         else{
    0 @* P2 L) |$ _- G# G$ P0 q
18.                                                 if (posts != null && posts != '')
    
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    , W9 U' H9 v4 P5 o
20.                                                 else
    
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    ! |) W; k7 }5 z! N& p; s4 N5 L
22.                                         }
    ( \- c0 O8 P$ x
23.                                 }
    
24.                         });
    
25.                 },
    
26.                 createControl : function(n, cm) {
    
27.                         return null;
    
28.                 },
    
29.                 getInfo : function() {
    
30.                         return {
    
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    % h( O2 ?& @0 e% G. I
33.                                 authorurl : 'http://9iphp.com',
    # {* u" X! {* E: M  `& Z
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    4 [. W" G+ O: w  e
35.                                 version : "1.0"
    : f7 q) |4 K0 S7 @! u3 T6 ^
36.                         };
    8 K7 f! |- L) Q. x+ j
37.                 }
    1 _; j9 l1 Z1 a3 G( N; j
38.         });
    
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    7 @% c+ L- ?& D  l; p
40. })();

複製代碼

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

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

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

+ e! f# }1 n9 v

4.2 註冊按鈕及TinyMCE插件

% ?0 @0 M# T' t- o

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

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

1. function register_button( $buttons ) {
   
2.         array_push( $buttons, "|", "recentposts" );
   % ~; v# y6 k% Z% c! r1 x; G. E7 I% T. R  z
3.         return $buttons;
   " Y9 j. V: W2 ~) L6 t
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
$ F; b' E* i6 w, a( D+ p

1. function add_plugin( $plugin_array ) {
   
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   9 m/ B+ e' ]- j
3.         return $plugin_array;
     q% X* p4 O# A+ q- h
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;
   
4.         }
   
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   6 Q9 O( C* c$ E- G% t+ [
8.                 add_filter( 'mce_buttons', 'register_button' );
   - ^) u( f# k. o, ~) v9 g. D7 T
9.         }
   $ }2 t: T5 b: ~7 G. i1 f4 t) I
10. }

複製代碼

當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
2 Q8 R9 X6 Z. o2 W7 a3 y7 `( U7 Y最後把函數勾到Wordpress初始化函數

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

複製代碼

- d1 D4 f. q' \5 m- ^  @! T4.3 按鈕的用法

  n: l2 P- s* ]

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

5 ^0 r( t& ~4 s6 E' c+ z

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

! l3 O- y  j) H. l  U8 D$ h( N

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

- d% A9 L! y& s" C. z

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

# k$ _/ N( h' Q+ U

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

參考文章: 1 2