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

IT_man

WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
6 U0 D- [8 i& m4 T
0 y7 g# s2 u1 g3 W' p5 Jwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
; j3 b4 p( K1 u5 t以下是 wordpress 短代碼的詳细介紹及進階應用。
' ?9 x. Z1 `+ z' F
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
+ y! U& D6 v& l# I; o" L* [

1. [recent-posts]

複製代碼

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

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
9 _0 g; R4 L1 h8 T! M7 w) p

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

複製代碼

1. 簡單的短代碼
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
" X4 |/ B0 O2 w: o8 g- e

1. [recent-posts]

複製代碼

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

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

本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
1.1 建立返回函數
" ]) u; `* J; y' P4 P% Q) ~2 P7 D當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
) z9 d7 J% b5 v/ \- ~

1. function recent_posts_function() {
   
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   ( Q$ j1 Y! h# v/ b6 L4 q; F4 n, g- M
3.         if (have_posts()) :
   
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   7 i: l3 R: t7 l3 R
6.                 endwhile;
   0 A( ^# x. Y$ u9 }$ E& C7 R
7.         endif;
   7 y+ z7 S  M: [3 V( P4 [$ t
8.         wp_reset_query();
   + n( O: X# z4 B, g. x
9.         return $return_string;
   
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
  P0 B3 F6 r6 i' i7 t5 B
' _& A5 I6 x- m* g
1.2 註册短代碼
) o1 p" I, T! Y現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   : L, G( |5 a  j: G1 C' b( @- g1 w
2.         add_shortcode('recent-posts', 'recent_posts_function');
   ( ]8 G: J+ G) K; E+ _! [
3. }

複製代碼

當在文章的內容中使用短代碼
& p  |; H! X# |, y3 t! b+ m

1. [recent-posts]

複製代碼

將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。
. o) M4 L1 I$ H! ~1 @. M
) _6 h7 [% r6 }& g1 |5 p6 k% Y
1.3 Hook into WordPress
- b; g3 v) w& z' Y- Z4 O8 f4 F
9 p* R! u) E) M' |0 O為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。

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(
   ' f  K* G4 y7 A; l  O
3.                 'posts' => 1,
   
4.         ), $atts));
   ( L; j- Z9 b- {6 k" [$ s% ~
5. 
   6 H) {" y8 s+ H2 h' e8 d
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>';
    & a3 u) k8 q1 I! Z# p7 Y
11.                 endwhile;
    - U% V9 w6 u  t* ~/ ]. P9 [* n6 ]
12.         endif;
    
13.         $return_string .= '</ul>';
    , S# I, U& B2 h1 f& N) }
14. 
    
15.         wp_reset_query();
    7 p0 ]* s( J6 P" C$ H; Z* ?
16.         return $return_string;
    % I1 K. z" b6 Q3 p4 K. Q
17. }

複製代碼

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

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

複製代碼

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

7 m$ Y8 O, a* n2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   8 k. N) o1 I! K1 m1 r1 \7 t
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   5 Y$ B; P% o+ b- S; s; j- F. m
4.         ), $atts));
   - ~2 ]& F+ @( n& J" {5 g
5. 
   
6.         $return_string = '<h3>'.$content.'</h3>';
   - ~% L$ S/ q/ l3 k, }
7.         $return_string .= '<ul>';
   
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
9.         if (have_posts()) :
     M1 ?  P/ O1 r$ t
10.                 while (have_posts()) : the_post();
    
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    / |5 Z8 o! I0 H) O9 x$ }
12.                 endwhile;
    + M0 Z; r8 g3 L/ H4 {
13.         endif;
    ' c+ a1 K* ^' Y5 i
14.         $return_string .= '</ul>';
    - O1 L' \. n4 j, w; C( {& ]
15. 
    
16.         wp_reset_query();
    , j) f6 l. |6 d' |: B' W4 y- P; c7 B
17.         return $return_string;
    
18. }

複製代碼

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

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

複製代碼

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

2 Y! ~# F" V. v

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

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

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

: ~" O) p3 Q" z: _9 v0 d( R2 |" S1 ]

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

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

複製代碼

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

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

4. TinyMCE編輯器增加短代碼按鈕

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

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  

" C( f& ]& G% w1 [4.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.                 init : function(ed, url) {
   ; e& _, W. I* ^( x, x7 U* t% i
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   $ R6 e# u0 Q% ]2 g
6.                                 image : url+'/recentpostsbutton.png',
   4 E. {7 h3 R$ H
7.                                 onclick : function() {
   
8.                                         var posts = prompt("文章數量", "1");
   
9.                                         var text = prompt("請填入列表標題", "最新文章");
   
10. 
    9 i2 ^* E! D. r- m: S: H. K
11.                                         if (text != null && text != ''){
    
12.                                                 if (posts != null && posts != '')
    2 P# J9 n$ Q" R. ^- G) e: W
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    - H0 I1 T: ]* T
14.                                         else
    
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    $ u. x& V, M: P9 _. L, D! y$ I, }
16.                                         }
    
17.                                         else{
    % B- Y* a. @# j5 z$ y& Y( t
18.                                                 if (posts != null && posts != '')
    
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    
20.                                                 else
    
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    
22.                                         }
    
23.                                 }
    
24.                         });
    
25.                 },
    
26.                 createControl : function(n, cm) {
    1 D$ b) o4 f: C, S3 C" [# N" c3 Q& ~
27.                         return null;
    . \8 r6 w# j; M; a
28.                 },
    / c# M/ j+ ^, T$ r) Y- Y
29.                 getInfo : function() {
    
30.                         return {
    
31.                                 longname : "Recent Posts",
    0 e0 B. E. g0 N1 V- X5 A! M9 e
32.                                 author : 'Specs',
    0 O4 Y' Q5 G# r/ J) S3 _% ~4 `' D4 R
33.                                 authorurl : 'http://9iphp.com',
    1 y# q: W' B4 Q4 m) f
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    ) r4 N" o0 H( S! ]) d7 z# m% _4 C
35.                                 version : "1.0"
    ! ?: L' C" ?$ [/ r7 c2 |
36.                         };
    ! [1 W2 g* p; d8 P0 U
37.                 }
    8 p/ t% v7 s6 k
38.         });
    
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    
40. })();

複製代碼

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

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

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

+ g" y5 D& l  A0 n1 V3 P

4.2 註冊按鈕及TinyMCE插件
7 _( D# e2 _+ }8 K& H' d3 @5 `

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

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

1. function register_button( $buttons ) {
   / [* v% ]3 J, M2 R6 S
2.         array_push( $buttons, "|", "recentposts" );
   ) }" T0 R4 Z/ c5 G
3.         return $buttons;
   
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
$ S, Y2 p( k( l

1. function add_plugin( $plugin_array ) {
   7 ?& Y. G: j& k" p' b5 W% j
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. function my_recent_posts_button() {
   6 ?. T- W6 l9 I* _( @/ W
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   
4.         }
   # f. I" |: X: W9 |
5. 
   9 V9 Q4 T  s- G2 p+ a/ }
6.         if ( get_user_option('rich_editing') == 'true' ) {
   8 ?2 X6 g4 w, o! _6 [  i
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   
8.                 add_filter( 'mce_buttons', 'register_button' );
   0 f: [% K1 A2 r' q  s/ U
9.         }
   
10. }

複製代碼

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

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

複製代碼

0 G6 V2 u! n/ Y& ^4.3 按鈕的用法

- x) A. D7 j' G1 T. n) h

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

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

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

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

8 v) C( W' f5 C* [: r( j3 m

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

參考文章: 1 2