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

IT_man

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

4 L' s" P; Q! ?( p" @# T) Q* o( Rwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
) ^5 r7 \' m3 ~4 [( x以下是 wordpress 短代碼的詳细介紹及進階應用。

短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
& p; T( `6 a8 t. }7 q

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
- P$ g. C) o3 \9 z

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

複製代碼

1. 簡單的短代碼
, O/ s3 {# O2 {/ s本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
+ h9 M" H$ f5 X8 l* l) C4 j9 [

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
9 w. d* ]7 r  q; m

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

本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
1.1 建立返回函數
9 z' M& A5 H  h6 Q$ E/ g當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
. ]% |* b7 u! ^6 D  |

1. function recent_posts_function() {
   - C: f1 t, x# e% Z' |
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   6 [0 e, f# a- P+ S: g
3.         if (have_posts()) :
   
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   
6.                 endwhile;
   
7.         endif;
   ; }4 y  C: P3 Q0 o! R) }! N& Z
8.         wp_reset_query();
     q* u; i! `/ R3 b0 k1 g" W
9.         return $return_string;
   8 v) K+ n" O4 W7 q
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
6 L  T# d3 ~# Q, z% |' ]* i6 V8 n

& {! t4 z) v) |8 ?( }0 t1 O1.2 註册短代碼
) l. y' Z  q6 a/ C- X2 ^' d現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   1 F& E- ~& Q. E% e% `% F
2.         add_shortcode('recent-posts', 'recent_posts_function');
   1 Q# u8 e6 l3 s7 _* Y8 J$ v9 m
3. }

複製代碼

當在文章的內容中使用短代碼
( n0 ~$ _# j+ ?5 x! o" n/ C

1. [recent-posts]

複製代碼

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


; T' y  g  L% v# D2 [4 G1.3 Hook into WordPress

為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
6 T/ q# r" D  h. {/ v# X9 j

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

複製代碼

1.4 測試短代碼
6 W7 [9 u6 b5 j6 j& D8 R簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   
4.         ), $atts));
   
5. 
   
6.         $return_string = '<ul>';
   % E. F/ a! X- ?, [+ A
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   3 c, U9 F8 r2 g, P
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    7 \# L; _; o* E5 F& N3 ]
11.                 endwhile;
    
12.         endif;
    % @7 V& `3 t" H: i2 P; b) Z
13.         $return_string .= '</ul>';
    / O9 r! E' ^0 t4 Y  ]9 {$ Z8 ]; G
14. 
    5 B+ v9 r' }. X
15.         wp_reset_query();
    ) J0 T1 T! y2 @: n5 X
16.         return $return_string;
    
17. }

複製代碼

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

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

複製代碼

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

2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   
2.         extract(shortcode_atts(array(
   7 X) O& v& Y, u1 W
3.                 'posts' => 1,
   / G( C+ ^2 ^. ~- ~
4.         ), $atts));
   1 _! M7 y) }5 q8 w6 }
5. 
   
6.         $return_string = '<h3>'.$content.'</h3>';
   
7.         $return_string .= '<ul>';
   
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   ( B( d" k" \$ ?$ u' ~; \: m2 P
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    , Q% h) o! p# ^/ E) h* b" O; I0 s
12.                 endwhile;
    
13.         endif;
    
14.         $return_string .= '</ul>';
    / D% ?4 ?! f1 C9 V6 K! d
15. 
    1 z4 f$ E+ O: E- J+ \6 v, X
16.         wp_reset_query();
    
17.         return $return_string;
    # n0 e6 j) [# e8 w; W8 G! K' Q
18. }

複製代碼

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

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

複製代碼

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

9 B/ n8 Y/ S5 R

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

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

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

8 G. l! j4 R3 k. ?- l& \' R9 N  ]

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

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

複製代碼

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

; x! b3 Y: J  F' |9 ?/ T

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

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

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

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  ! j+ K3 [* ?: q+ a) Q* s! u) f

4 k2 x4 F4 @2 J; {: L5 P6 b* C4.1 透過JS文件來建立按鈕

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

1. (function() {
   : M+ \3 s( z/ V% {5 r# G5 ^& c+ c
2.         tinymce.create('tinymce.plugins.recentposts', {
   
3.                 init : function(ed, url) {
   - ^# E4 l* C  t$ E1 L6 f
4.                         ed.addButton('recentposts', {
   ( [8 K# Y! j& U. F; o8 T; U
5.                                 title : 'Recent posts',
   1 v( d; B" ~4 p6 c# [, F/ m" t
6.                                 image : url+'/recentpostsbutton.png',
   
7.                                 onclick : function() {
   ) @' Z. r6 {6 P0 h3 }+ a
8.                                         var posts = prompt("文章數量", "1");
   
9.                                         var text = prompt("請填入列表標題", "最新文章");
   ' W2 q6 b& d/ s' ~2 w# Z
10. 
    
11.                                         if (text != null && text != ''){
    
12.                                                 if (posts != null && posts != '')
    3 O; I, ~+ [2 w9 U
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    7 y( c) |$ o3 p9 g9 }  D
14.                                         else
    
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    
16.                                         }
    % u8 @* V2 @9 m! A/ l7 v
17.                                         else{
    
18.                                                 if (posts != null && posts != '')
    3 Y" N1 d, ~* J& d6 X. Q6 r( m
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    & N2 t' Z  m9 \4 S
20.                                                 else
    9 D' p. n* s- t& }$ x
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    
22.                                         }
    1 o- S6 ?. X# ~# W- ^" r( \% _- a
23.                                 }
    
24.                         });
    1 ]' r; @% ]0 ]  h  h; I7 _) ?
25.                 },
    
26.                 createControl : function(n, cm) {
    - m3 f0 U" P1 Z- |
27.                         return null;
    
28.                 },
    9 _; S1 d8 v+ R8 z  Y7 D0 b
29.                 getInfo : function() {
    # l1 P/ t3 }2 o
30.                         return {
    # f$ f2 ?5 |) k
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    / H  s/ y; p: v9 ]8 s
33.                                 authorurl : 'http://9iphp.com',
    " y3 b" Y/ g9 e$ x5 v* z- _
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    2 x3 \9 F% h2 x8 s% [/ c1 b
35.                                 version : "1.0"
    4 ]( _4 W# x4 [7 J/ w  F% s
36.                         };
    
37.                 }
    
38.         });
    
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    
40. })();

複製代碼

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

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

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

5 [# e" O. `: ^$ k

4.2 註冊按鈕及TinyMCE插件
  i: g* Z' P* R% X( O/ Y
2 |% P( s! N: c. v' c" Y

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

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

1. function register_button( $buttons ) {
   $ V& A$ w8 P: U1 B
2.         array_push( $buttons, "|", "recentposts" );
   ) {  s. o6 g# Y/ J$ n8 C
3.         return $buttons;
   
4. }

複製代碼

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

1. function add_plugin( $plugin_array ) {
   : D  X+ Q1 t% o, Q5 v( ~8 f) u
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   1 r( ~# i: g/ |' F7 H9 S
3.         return $plugin_array;
   
4. }

複製代碼

下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。

1. function my_recent_posts_button() {
     ]' D( T1 N9 _8 e
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   7 N( d* U+ E/ \) Y; b9 Y( [, S
3.                 return;
   
4.         }
   ; n# \' T8 S; }
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   
8.                 add_filter( 'mce_buttons', 'register_button' );
   
9.         }
   * j, ~1 h" f+ J8 K. X4 x" l; `& h
10. }

複製代碼

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

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

複製代碼

& ?% W1 D- B, f% O( Q4.3 按鈕的用法

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

3 n# t( {$ m! Y: D3 i) G3 K/ I( E

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

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

/ P6 |! J; V) {/ M5 p# J

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

: ~  B4 R" C% g3 I4 g8 {& n- Y+ s

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

參考文章: 1 2