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

IT_man

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

) n& V- B7 z' X' B. J) Ewordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
以下是 wordpress 短代碼的詳细介紹及進階應用。
6 J; O" O' m6 R
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
) o( o. B: C1 m* e; T' S

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
+ l7 a, B: W# o# N

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
, D3 p1 r. Y8 S

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

複製代碼

1. 簡單的短代碼
3 s* W+ u6 O# j" `3 `" U4 P! o本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
$ S' a* u( |2 V; {# N; e

1. [recent-posts]

複製代碼

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

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

本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
1.1 建立返回函數
+ X2 P* p/ ]8 W$ ~- J% f當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。

1. function recent_posts_function() {
   4 }7 }* }3 }! X) A1 G, l
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   & }' }* |" T/ }3 o9 k2 ?& ]1 I. ^
3.         if (have_posts()) :
   % i# ~  `- s; P, O9 v* }
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   
6.                 endwhile;
   + `9 H  u9 a( Z- V  J8 A
7.         endif;
   
8.         wp_reset_query();
   
9.         return $return_string;
     X, n0 f; [  G0 u$ B0 |, ]- V
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
* A# {  |' u- c9 t0 P1 e4 i. t! C1 Y
' N: P/ n+ J( R* v6 f" z* t; O4 p
, G) v7 k$ J# d* T* q$ [9 @7 _0 j# A1.2 註册短代碼
現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   ; P8 J! c4 k3 l9 Q) S
2.         add_shortcode('recent-posts', 'recent_posts_function');
   + o7 d( \6 k  w/ f  u2 B+ R
3. }

複製代碼

當在文章的內容中使用短代碼
5 b$ j4 ~" }* i; J$ |) v: A3 j3 f

1. [recent-posts]

複製代碼

將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。
9 r* w: c2 B. e' A$ ~

/ O6 C1 ~1 u* O1.3 Hook into WordPress
6 u1 o, ^$ M6 p4 L1 ~3 `
為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
. |5 E; ^' [' W9 X; ]' }" {' G

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

複製代碼

5 f$ z' Z. h- S5 m1.4 測試短代碼
簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   
2.         extract(shortcode_atts(array(
   7 D  N2 r6 E' u! y6 M" ]5 J
3.                 'posts' => 1,
   3 p6 U3 {5 [, ]) n
4.         ), $atts));
   ) s0 U7 ]. w0 s0 a/ ~1 x
5. 
   
6.         $return_string = '<ul>';
   7 M$ Z" f" G/ R$ t; M
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   2 f5 N0 t8 O4 {7 O1 T+ V  A- V
8.         if (have_posts()) :
   1 \; p& p3 `5 r; c% Z9 ~/ V
9.                 while (have_posts()) : the_post();
   0 u* w6 _# v  e, L, ?( i: ~$ X
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
11.                 endwhile;
    $ a4 v  l/ H7 s- e4 U! @$ a/ W  F
12.         endif;
    1 m  v3 B- ]8 h! B4 J  _
13.         $return_string .= '</ul>';
    ) W: G( k9 Y" f& l3 [- x
14. 
    
15.         wp_reset_query();
    0 s/ N) C* N+ _2 Y+ C1 I. Z  c
16.         return $return_string;
    2 }! [3 U! }7 q
17. }

複製代碼

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

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

複製代碼

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

2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   ( U; M4 W) z1 }- f/ `! c
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   
4.         ), $atts));
   2 Y2 L8 R( F1 S8 W1 B9 T6 }
5. 
   
6.         $return_string = '<h3>'.$content.'</h3>';
   * y1 R  q* f/ A; n, n' X
7.         $return_string .= '<ul>';
   * d: `8 V9 p* L/ y( S, C: l0 B
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
     t' y+ C3 n. t$ R* r" _
9.         if (have_posts()) :
   ) K) j0 T( K; G1 a! ^
10.                 while (have_posts()) : the_post();
      G9 p% i* N/ O2 Y. Z
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
12.                 endwhile;
    # [5 M, |) P+ {  R+ W
13.         endif;
    0 Q& k1 L) v, E' M3 E8 H/ e
14.         $return_string .= '</ul>';
    : Z3 N1 `9 f1 d# c1 Q8 G8 U) U
15. 
    ; |; c9 ^7 L# v4 e/ Y9 X8 ^  m3 s) {
16.         wp_reset_query();
    
17.         return $return_string;
    1 x4 H# N; |. N2 K9 t
18. }

複製代碼

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

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

複製代碼

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

2 V+ ?: [( Q5 z

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編輯器增加短代碼按鈕

雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  5 f+ G' I; ^! Q6 v9 \, F7 r. }

( Z* o6 V5 O. E4 q4.1 透過JS文件來建立按鈕

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

1. (function() {
   7 Z  K8 p' i, L" o1 |  y
2.         tinymce.create('tinymce.plugins.recentposts', {
   
3.                 init : function(ed, url) {
   ! F6 V# w- u) V7 g- N3 U$ [
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   
6.                                 image : url+'/recentpostsbutton.png',
   5 Z4 G/ \2 b* y# }: J% C: L5 `' M
7.                                 onclick : function() {
   7 Q6 o" E) s( t0 l1 U0 v; M
8.                                         var posts = prompt("文章數量", "1");
   ; e: c8 A# j$ J) T: x7 x: d
9.                                         var text = prompt("請填入列表標題", "最新文章");
   3 }0 u7 e% F& f9 x
10. 
    
11.                                         if (text != null && text != ''){
    
12.                                                 if (posts != null && posts != '')
    
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    ' \) h8 l4 W. [# ?. N1 f; J  U
14.                                         else
    
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    
16.                                         }
    $ ?0 s8 _: u% {' q- E
17.                                         else{
    & h9 e- }- i) r! t6 O. h
18.                                                 if (posts != null && posts != '')
    5 W' O3 g1 F$ d3 n3 o& T3 ~
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    
20.                                                 else
    
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    " G* o% A3 w' Z) n2 j4 U' r
22.                                         }
    $ }/ A# J* H) r: P: `
23.                                 }
    
24.                         });
    
25.                 },
    + V1 y0 y! {2 D" z
26.                 createControl : function(n, cm) {
    
27.                         return null;
    5 X1 s8 _$ ~- J$ s
28.                 },
    
29.                 getInfo : function() {
    
30.                         return {
    
31.                                 longname : "Recent Posts",
    : W8 m4 T. s: u, d0 R# ^( ?% v
32.                                 author : 'Specs',
    
33.                                 authorurl : 'http://9iphp.com',
    8 j7 l2 z4 q: e
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    
35.                                 version : "1.0"
    
36.                         };
    8 G' g% P6 {/ `, t" i/ M
37.                 }
    4 ?4 w7 E( x4 }) ^1 r
38.         });
    9 ^, [/ K* Y5 r# q+ o. E3 z: [. Z
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    
40. })();

複製代碼

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

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

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

4.2 註冊按鈕及TinyMCE插件
5 X+ D2 n' y, k# s( b7 q; o
3 G3 v( z* P% B& Y" G" _1 S

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

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

1. function register_button( $buttons ) {
   
2.         array_push( $buttons, "|", "recentposts" );
   
3.         return $buttons;
   
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
* @- Z+ s* k/ ^3 x+ K

1. function add_plugin( $plugin_array ) {
   + v6 I$ i5 T$ M
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 過濾器，當載入按鈕的時候執行。
% _1 g/ P# ~' e3 U" S$ Q; L

1. function my_recent_posts_button() {
   2 D; ^5 g" @* L. l
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   * p$ x6 A; z9 [- l
3.                 return;
   
4.         }
   2 E+ d: g+ L3 N' I. v% H1 m
5. 
   9 n4 K8 I: b4 K4 R
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   
8.                 add_filter( 'mce_buttons', 'register_button' );
   1 l" {( r8 i$ Y
9.         }
   # a3 K# K; i  _  n! q0 _
10. }

複製代碼

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

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

複製代碼

4.3 按鈕的用法

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

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

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

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

4 H. Z- f: ^: g* p" t: o

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

參考文章: 1 2