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

IT_man

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

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

% B  f' \" A, V6 }4 w' @) k( ^; b; A! ]4 u短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :

1. [recent-posts]

複製代碼

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

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
( x* }. Z6 l4 i8 w* C7 e( o

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

複製代碼

/ L; p9 o) m- h: X# `
1. 簡單的短代碼
) s! c8 m6 a: B1 Z本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
+ x+ z) X5 _# d" R- I( K, w

1. [recent-posts]

複製代碼

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

• 建立一個函數 , 當 wordpress發現短代碼時會呼叫此函數 ;
• 藉由設置一個唯一的名稱來註冊短代碼 ;
• 把註冊的函數連結到wordpress的action上。
  0 C) P6 c; x2 r2 [8 n4 w9 S

7 W  F+ T' z8 L' H  W, z7 f+ `$ e本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
- G$ Q9 G, E  X+ O3 M1.1 建立返回函數
當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
8 T5 |' \) Q" A& W, }

1. function recent_posts_function() {
   $ Y8 b9 N' {; K
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   
3.         if (have_posts()) :
   
4.                 while (have_posts()) : the_post();
   % h& J9 w3 ]# ~0 F3 f: q( z3 U
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   ! {8 u" b1 M( r1 u) q. L% X! K% R
6.                 endwhile;
   
7.         endif;
   
8.         wp_reset_query();
   
9.         return $return_string;
   
10. }

複製代碼

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

6 E  _  Y8 G9 U
1.2 註册短代碼
; b' J* E% [5 T' S, v9 y8 A  x現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   
2.         add_shortcode('recent-posts', 'recent_posts_function');
   7 V1 N; \8 B" R% B. ]6 u/ T6 |
3. }

複製代碼

當在文章的內容中使用短代碼
8 A6 a* H- u  j+ W+ w' \# Y5 ?

1. [recent-posts]

複製代碼

將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。
% m# ~& `# \% t2 u# o8 |2 m

1.3 Hook into WordPress
' a% X7 S5 E/ F1 p
為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。

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

複製代碼

& y0 m6 c# z4 H& ?" B1 a1.4 測試短代碼
" x* L% m; Q5 ?% @- A7 Q簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   
2.         extract(shortcode_atts(array(
   - i/ G$ B; K+ `8 t( ?8 M# Z
3.                 'posts' => 1,
   0 t# C+ Q5 G" B# D/ e% Q3 V
4.         ), $atts));
   6 Y. N9 ^, X6 M! \
5. 
   5 H  Z  e% k; D3 E3 ~
6.         $return_string = '<ul>';
   
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   / N, C7 I- h4 M2 n2 v* H2 ]) g
8.         if (have_posts()) :
   # Q2 w' @5 P; Z
9.                 while (have_posts()) : the_post();
   , N' C" \* e- H1 Y& q+ F# Z, F
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    6 w# w$ H  _8 m% S: R
11.                 endwhile;
    
12.         endif;
    ' j' x% d% C8 B( T; f
13.         $return_string .= '</ul>';
    
14. 
    
15.         wp_reset_query();
    : M: ~# S) h6 }+ W/ W3 U; {
16.         return $return_string;
    9 ~/ k* p% z: Z" ]) ^
17. }

複製代碼

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

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

複製代碼

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

2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   
2.         extract(shortcode_atts(array(
   5 y9 d2 n5 V" E; `# S2 x/ p( e
3.                 'posts' => 1,
   
4.         ), $atts));
   - }7 K% Q! z( H1 I+ @; @# R
5. 
     V: u& F  d" [& A. M$ w
6.         $return_string = '<h3>'.$content.'</h3>';
   
7.         $return_string .= '<ul>';
   ' S( S0 l; t- p7 r" H
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
9.         if (have_posts()) :
   6 R* f, a. R9 H& v- I( A* m
10.                 while (have_posts()) : the_post();
    - ~, H( x& J7 P2 ^* c
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    5 p3 {% e; M* r8 e
12.                 endwhile;
    , R7 d  o* q" J) R! q/ e6 x
13.         endif;
    
14.         $return_string .= '</ul>';
    
15. 
    
16.         wp_reset_query();
    3 M7 K8 K* @& G. O# I& m
17.         return $return_string;
    ' L, E/ I  |4 B1 t2 G% ?/ A) Y
18. }

複製代碼

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

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

複製代碼

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

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

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

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

$ l7 d9 }# F( r0 U) v, z

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

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

複製代碼

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

/ z( h( N; |* ^9 ~9 H. v  K

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

4. TinyMCE編輯器增加短代碼按鈕
0 s" q, b' p- r& W9 G& p0 }  R
. y& S; m" T# v雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  8 ?* B+ }. l9 r9 s1 o, D$ g

2 ]% |( l: l! e2 ^+ D2 `# B" B4.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 j! g- m! Z- a' A! ]; ^
3.                 init : function(ed, url) {
     @: ^6 A4 ]2 f% v* I/ N( Q
4.                         ed.addButton('recentposts', {
   ' {: e, V7 k7 B: p
5.                                 title : 'Recent posts',
   ) L) W! D3 I% d7 y, d; F
6.                                 image : url+'/recentpostsbutton.png',
   7 _5 x% y2 j, P
7.                                 onclick : function() {
   0 I* v5 f- M4 U
8.                                         var posts = prompt("文章數量", "1");
   
9.                                         var text = prompt("請填入列表標題", "最新文章");
   , j5 V( f. [, G. _
10. 
    7 j+ E! s( r% m
11.                                         if (text != null && text != ''){
    3 m, u7 Y- d: R( J& I
12.                                                 if (posts != null && posts != '')
    
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    : \/ P! J2 V; h
14.                                         else
    ( G. q. b# a2 ~/ q9 V: \7 e
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    
16.                                         }
    
17.                                         else{
    
18.                                                 if (posts != null && posts != '')
    
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    8 x  S" i  i4 |7 Z+ C
20.                                                 else
    
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    ( _0 f) S0 w( O' A1 E
22.                                         }
    
23.                                 }
    
24.                         });
    
25.                 },
    " |# Q1 ?, m8 K# J. c3 v
26.                 createControl : function(n, cm) {
    
27.                         return null;
    $ [8 F: d: r2 n5 u1 a
28.                 },
    
29.                 getInfo : function() {
    ) m- y2 o' K( k5 w9 e. z3 C
30.                         return {
    / b) @# J. |: A- A. F/ V: C% R
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
      R: }1 B7 @- y1 {  Q( ~- x, Y5 Q
33.                                 authorurl : 'http://9iphp.com',
    5 w- k  u/ r: m! _
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    
35.                                 version : "1.0"
    1 J0 I/ h4 {7 J1 i# Y: S" A- H
36.                         };
    
37.                 }
    + h- D$ o7 ]) [# x0 _. b6 y
38.         });
    
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    1 [( F: ~1 ]! `; ^
40. })();

複製代碼

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

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

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

# ]; ?4 a4 ]6 t

4.2 註冊按鈕及TinyMCE插件
# i4 h' W; O( Q6 E1 [1 M
' a2 P( N0 t: }1 w9 z

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

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

1. function register_button( $buttons ) {
   
2.         array_push( $buttons, "|", "recentposts" );
   
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';
   
3.         return $plugin_array;
   ) x- p! ~8 J" U+ R. f' \
4. }

複製代碼

下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。
7 N* b7 q; k$ `3 m9 D+ g5 z9 D

1. function my_recent_posts_button() {
   
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   2 a2 r# B8 U5 ?3 p' y: C
3.                 return;
   
4.         }
   
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   - ~; n4 V( x. K* I: f
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   8 r$ K2 z' {- O. u5 Z
8.                 add_filter( 'mce_buttons', 'register_button' );
   + r2 V* W; ~2 p7 [" e  e
9.         }
   
10. }

複製代碼

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

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

複製代碼

1 P, v( ]0 M3 y) q6 y7 k. V9 g4.3 按鈕的用法

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

0 {' A( }; A- u& K7 U: B3 @

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

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

" ^" \1 }; f# p5 c6 _9 n

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

6 y0 b# t3 L$ ]7 \  |- k( _

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

參考文章: 1 2