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

IT_man

tid=39737&WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
5 E) v' i# P( L# v/ R
wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
, E, _0 d/ e" y以下是 wordpress 短代碼的詳细介紹及進階應用。
" P3 l7 _' E# ~7 A9 ~, G( a
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
7 n$ y$ X' U2 `7 T

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
' Y, A/ r8 K1 S: x! I& H

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

複製代碼

6 N3 u/ q; S  ?& f3 m1. 簡單的短代碼
% }9 C1 j# c2 e  C, W7 [* \/ O本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
8 |1 p  d# i* d

1. [recent-posts]

複製代碼

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

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

3 {' H7 E) T! ^! {) V8 l. {/ R) {本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
1.1 建立返回函數
: P; _, y3 a* X當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。

1. function recent_posts_function() {
   
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   $ H5 Y4 T/ H2 l+ f1 q' I
3.         if (have_posts()) :
   ; U* }, z! Q: m/ z. Z$ p# m
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   
6.                 endwhile;
   - J) E2 C3 ?4 r7 v. {
7.         endif;
   2 B/ j2 w) E: N6 Y) F7 S7 O
8.         wp_reset_query();
   
9.         return $return_string;
     B  E  m- [6 A$ O( T6 O1 ^
10. }

複製代碼

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


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

1. function register_shortcodes(){
   
2.         add_shortcode('recent-posts', 'recent_posts_function');
   ( \! b% |! P  i
3. }

複製代碼

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

1. [recent-posts]

複製代碼

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

/ b* l% ~; l" `. {, r( C9 y: Q9 F
1.3 Hook into WordPress
+ N) ^9 Z, F) _$ J- f- d( r/ V' j3 S
& m* g& S( V/ U1 M為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。

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

複製代碼

' W# U' r. l2 E: _5 h% J1.4 測試短代碼
* V5 P; h; K* v. ~! d/ Y* |簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
     W" Q6 |, C3 O7 q4 W
2.         extract(shortcode_atts(array(
   ) ^" T: e/ u* O5 v" N
3.                 'posts' => 1,
   3 b7 _. _* K% p6 A6 D/ |0 k5 f+ x
4.         ), $atts));
   
5. 
   
6.         $return_string = '<ul>';
   
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   ( f8 Z. Z5 _3 G2 r
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    ' _! @/ w% ^7 h
11.                 endwhile;
    
12.         endif;
    
13.         $return_string .= '</ul>';
    
14. 
    / k8 J0 c8 c: s; p) T0 |$ B8 R2 ^& ]) f
15.         wp_reset_query();
    
16.         return $return_string;
    
17. }

複製代碼

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

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

複製代碼

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

1 T" w% h' B3 R7 k2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   
4.         ), $atts));
   . V* E3 J" y5 p4 X9 b
5. 
   . N. }- n! v, Z4 |: B. W
6.         $return_string = '<h3>'.$content.'</h3>';
   2 H" J' g* {! P; b1 Q
7.         $return_string .= '<ul>';
   8 w3 ]/ u/ ]1 g* N3 w
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   % `% B7 \1 \, i0 s! O
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    ! V) x; `7 \0 `. T  W- n
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
12.                 endwhile;
    
13.         endif;
    % X, A5 U" C7 l  G  n
14.         $return_string .= '</ul>';
    $ L8 _' i" ]  @: `8 n/ F; G! J
15. 
    
16.         wp_reset_query();
    $ i8 n. x3 i( ~( R2 }
17.         return $return_string;
    ! b3 i- l# ^7 W: b+ M. E: d
18. }

複製代碼

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

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

複製代碼

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

/ F4 q! b. c& k9 u  h1 Z

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

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

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

) n) Y/ E0 b7 D

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

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

複製代碼

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

& `6 S. h, T8 y) a8 }) n

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

4. TinyMCE編輯器增加短代碼按鈕
5 W" [  Z9 Y/ t  Q/ z5 F
3 D+ k, J. y* ]" j+ q雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  ! C/ `& S7 T7 v, `

4.1 透過JS文件來建立按鈕

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

1. (function() {
   " m* Y1 ]2 V1 G) O% y3 O( S, L! j
2.         tinymce.create('tinymce.plugins.recentposts', {
   3 {- t- Y! N! \
3.                 init : function(ed, url) {
   + a" F; j) M7 h: m
4.                         ed.addButton('recentposts', {
   6 \" `; `# ]+ Q" D
5.                                 title : 'Recent posts',
   7 R) w8 j6 K- `2 B5 o- {! _3 d
6.                                 image : url+'/recentpostsbutton.png',
   8 w- S# F, s  t# B8 O
7.                                 onclick : function() {
   - }0 x+ s) Z! R3 e" s: y: {* M
8.                                         var posts = prompt("文章數量", "1");
   # ]# Z7 v6 |' O& ^
9.                                         var text = prompt("請填入列表標題", "最新文章");
   " L& u3 h$ G0 Q4 y; u5 [
10. 
    ; Y7 S& P! N% ]  _4 L& J$ c
11.                                         if (text != null && text != ''){
    3 i4 I; k1 n# H; C0 g  C: P- l
12.                                                 if (posts != null && posts != '')
    * {7 n3 n' m  ^
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    
14.                                         else
    ' m: G1 g* q$ l4 I+ ?
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
      A, K% }- Y* O+ |; A& g# _
16.                                         }
    0 p: E3 b% j& K$ o2 C; ^  P6 o, g* [! g
17.                                         else{
    9 U$ x. [) ]4 j4 }! E+ k  `
18.                                                 if (posts != null && posts != '')
    
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    
20.                                                 else
    ! g  k) ]& N: R+ y
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    
22.                                         }
    , h$ d( A3 W* g
23.                                 }
    
24.                         });
    : s0 g$ c5 {7 x1 r8 ~
25.                 },
    & c) D0 F4 e% ?5 J% n
26.                 createControl : function(n, cm) {
    
27.                         return null;
    
28.                 },
    
29.                 getInfo : function() {
    , s8 X$ a% P: s7 R
30.                         return {
    
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    
33.                                 authorurl : 'http://9iphp.com',
    5 n0 Y6 U0 B; U* N1 j$ E# u
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    
35.                                 version : "1.0"
    & x$ b- d( l) b
36.                         };
    
37.                 }
    
38.         });
    
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    * S) U0 y  S! c0 O5 ~; M" [( o6 w
40. })();

複製代碼

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

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

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

4.2 註冊按鈕及TinyMCE插件

7 O/ t; y  v( w- t  b: Y

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

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

1. function register_button( $buttons ) {
   
2.         array_push( $buttons, "|", "recentposts" );
   " z3 Z% e' B, Y* O) N' {7 S
3.         return $buttons;
   
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
- b) t' P+ e+ H7 R0 X% @! A

1. function add_plugin( $plugin_array ) {
   
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   
3.         return $plugin_array;
   $ m- O# e9 m; P* B9 B* c
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;
   5 M  \; o2 L! ~( u' V! h/ n- o
4.         }
   
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   7 I( Q4 Q1 u% h, M( U) \4 O1 O
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   " e" Y3 `4 X; ]) D% J! y" D
8.                 add_filter( 'mce_buttons', 'register_button' );
   
9.         }
   
10. }

複製代碼

當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
- R- p6 v* p+ o+ x: R最後把函數勾到Wordpress初始化函數

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

複製代碼

9 S7 I( I3 I9 N9 D4.3 按鈕的用法

9 u7 z. |3 n. t6 \! Q1 h1 e# J

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

- G0 O( k7 T# G+ L$ P% n

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

: h% D) H0 K6 W; j4 H2 F

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

" o1 F3 G; j* G3 b

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

7 a, X6 H% f; M0 D( q! K$ E. A

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

參考文章: 1 2