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

IT_man

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

' `0 e5 E: A2 k- l9 Twordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
  Y3 G2 I* L+ X, ~5 ~, T5 U# E% g1 B以下是 wordpress 短代碼的詳细介紹及進階應用。

1 N7 B/ G- y; y* ]; ?短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
4 D9 ~. L. ]( N7 E* p

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
* ^2 F, |( J# d( B; O

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

複製代碼

* \2 @3 O" a+ [1. 簡單的短代碼
2 }0 m: e# B- U) n, f本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
% w6 K6 s- N4 ~/ J; I

1. [recent-posts]

複製代碼

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

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

. Z; X: T3 [4 h0 \. u% w) D5 J本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
1.1 建立返回函數
% N0 k1 M% q' ]* P1 J3 A& a4 i" R當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
" g& b% o) x# n: S2 z+ Q: i0 A

1. function recent_posts_function() {
     |' F9 p. }. Y: p6 n6 e/ `; K3 _4 ?
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   2 j$ l' }$ \# ^( N: N2 b6 b
3.         if (have_posts()) :
   
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   : f' Y3 A/ h7 z/ j3 T
6.                 endwhile;
   " A$ p2 t1 U8 M- d* o+ y
7.         endif;
   
8.         wp_reset_query();
   
9.         return $return_string;
   & a; G# _) D, @2 e
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
: J% d" s4 |6 C, _
9 V$ _3 G$ t: Y- b4 h3 D+ z2 x5 f4 V
  G/ [7 I4 q/ i! P7 r+ e! p' m1.2 註册短代碼
現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   
2.         add_shortcode('recent-posts', 'recent_posts_function');
   # K0 L" C/ V& p1 F' p4 c
3. }

複製代碼

當在文章的內容中使用短代碼
! ~9 K! l2 x$ C+ j& h8 S/ Z

1. [recent-posts]

複製代碼

將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。
8 G* B1 I4 q! E8 i$ L- t
% N) ?/ f; c7 _
( G) j. T9 j0 a& c! B# q" H1.3 Hook into WordPress
! a% ^# e' s* l0 O! n/ u
- ^7 J$ f  Z' M7 w, w* n; A為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
0 D7 {/ h  G; |/ B

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

複製代碼

1.4 測試短代碼
( Y/ `3 ]3 ]' l5 `) [) D' z  p" ]簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   3 u2 ?9 a/ d& B- p2 e
2.         extract(shortcode_atts(array(
   $ z, V9 ?! Y8 M' ~+ r+ h& ?* p
3.                 'posts' => 1,
   # e( J8 D3 r# `$ Q
4.         ), $atts));
   
5. 
   
6.         $return_string = '<ul>';
   + Q1 T! F" |* T8 w0 e' F6 I. k! I
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   " Q* I% h3 d3 e
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
11.                 endwhile;
    2 B# ~" \  D! n  ?: D
12.         endif;
    
13.         $return_string .= '</ul>';
    ) b, H$ w7 o7 M6 a% c7 p4 K" S  w
14. 
    
15.         wp_reset_query();
      M- o8 l0 r# X. U, u8 Y
16.         return $return_string;
    6 t0 ?# T6 X# x1 h' @! a( f
17. }

複製代碼

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

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

複製代碼

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

2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   $ V# L, R+ x' ^
4.         ), $atts));
     _, Q% z: {* p; K% u  T4 L5 t
5. 
   - G0 _- I9 \; T- e
6.         $return_string = '<h3>'.$content.'</h3>';
   & }8 U" V3 E' ^6 ]" h7 z* h, }+ J
7.         $return_string .= '<ul>';
   8 |: K9 }) l9 P' e0 V- c% c4 }8 g: A
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    ! ^& z8 \- I- e* D# w2 }7 y
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
12.                 endwhile;
    
13.         endif;
    
14.         $return_string .= '</ul>';
      _0 f4 ?  S% M
15. 
    8 r3 P& l+ ^  k" _1 a8 A( F
16.         wp_reset_query();
    9 E  z) W" }# i( _/ l
17.         return $return_string;
    / R2 L$ K! p5 q& b1 w5 E0 Y
18. }

複製代碼

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

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

複製代碼

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

# Z/ `* K  {- D+ A( h3 p- j" B

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

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

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  4 O$ y6 U. v* e# T# T" e

3 f5 [3 {) J) p6 l- w5 L4.1 透過JS文件來建立按鈕

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

1. (function() {
   - f( ^# g7 }" K
2.         tinymce.create('tinymce.plugins.recentposts', {
   
3.                 init : function(ed, url) {
     `2 q9 S4 T0 _5 K' _( d
4.                         ed.addButton('recentposts', {
   ' K4 l7 X- ]% a  w4 F4 n
5.                                 title : 'Recent posts',
   ; r4 q0 J2 P  A, X( c
6.                                 image : url+'/recentpostsbutton.png',
   9 I  M' _9 h) R# T8 k
7.                                 onclick : function() {
   0 B0 \0 c3 B/ e0 w3 A; D
8.                                         var posts = prompt("文章數量", "1");
   , X0 {  A7 b/ |, A; K2 Y7 N3 }
9.                                         var text = prompt("請填入列表標題", "最新文章");
   7 W; d- {4 m$ r4 |0 q
10. 
    
11.                                         if (text != null && text != ''){
    ' d# F6 m. Q  j1 s- J
12.                                                 if (posts != null && posts != '')
    8 G# [  _( ~9 _, S8 d. T
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    $ q1 n9 d6 Q! F0 o
14.                                         else
    
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    
16.                                         }
    
17.                                         else{
    ! P  F& X) z7 I+ h& Y+ Z9 G
18.                                                 if (posts != null && posts != '')
    
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    
20.                                                 else
    
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    $ P( G+ G# a3 f
22.                                         }
    5 i1 a% Y) W+ P# Y" y$ I2 C
23.                                 }
    
24.                         });
    ; N9 h4 Y% c# y* r+ _3 c
25.                 },
    
26.                 createControl : function(n, cm) {
    ! ^5 s! B* I  ?8 J$ w
27.                         return null;
    # U* i6 y) l' {
28.                 },
    
29.                 getInfo : function() {
    
30.                         return {
    
31.                                 longname : "Recent Posts",
    , b( Z0 S% s/ A/ B- {8 i& J. v
32.                                 author : 'Specs',
    
33.                                 authorurl : 'http://9iphp.com',
    
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    
35.                                 version : "1.0"
    
36.                         };
    
37.                 }
    
38.         });
    
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    ; i% P( D# W- Z  Z; l9 z
40. })();

複製代碼

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

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

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

4.2 註冊按鈕及TinyMCE插件
, R; @2 E/ u# _( Q
' L* w9 A/ q: v

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

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

1. function register_button( $buttons ) {
   3 L/ }2 X5 l9 m4 ]4 g7 V' x4 `6 Z% v
2.         array_push( $buttons, "|", "recentposts" );
   
3.         return $buttons;
   6 ]3 ~+ u- K. U+ D3 f$ U" A
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。

1. function add_plugin( $plugin_array ) {
   # n" {" Y+ Y4 f+ f. C% v4 o
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 過濾器，當載入按鈕的時候執行。
0 n6 m8 a5 ^. a+ r6 C/ ~0 t8 j) ~

1. function my_recent_posts_button() {
   - w) _* E# I: x' c0 g' f; Q
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   
4.         }
   2 I; L1 ~8 c/ C  ~9 ], s
5. 
     H5 A  |* ^3 J5 u& B
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   
8.                 add_filter( 'mce_buttons', 'register_button' );
   $ Z" F" P; Z; V3 ~* R
9.         }
   ! y! L8 N; s! k) a
10. }

複製代碼

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

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

複製代碼

4.3 按鈕的用法

* X" J% U% \) U7 l( O& _. X

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

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

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

' D+ ^0 |8 Y# z$ J1 m# Z

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

" a8 z7 H7 Z/ A" z5 {

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

參考文章: 1 2