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

IT_man

WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
5 C5 k8 X) _2 S  w' [
6 v- T. ^& v% |0 q4 z" C( Fwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
以下是 wordpress 短代碼的詳细介紹及進階應用。

# C+ ?$ k5 W$ I( }! s9 c# J短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
$ g4 a) r' A+ N# |, C

1. [recent-posts]

複製代碼

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

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
% |& H6 F4 s4 p8 F: e! i* r4 s

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

複製代碼

* [: [, h$ _  L8 v% o
; G% y5 c! }2 s6 p( _7 o! Q: Q1. 簡單的短代碼
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
  k' T8 G8 u3 t2 Q. T

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

- I3 {% h7 |; H+ i1 o2 b本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
6 I6 U1 s( b  ]3 [; V+ L. ~2 b1.1 建立返回函數
當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
/ C! h0 `6 C4 l' g) O$ S0 ^

1. function recent_posts_function() {
   & a. ~6 b; m# Y- \
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   
3.         if (have_posts()) :
   6 Z: R+ F) v+ U: q
4.                 while (have_posts()) : the_post();
   ( {0 V$ S5 B* q) o+ z+ D2 U7 _% w
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   ! M% r( l: ?( z
6.                 endwhile;
   * U( f" z8 Y6 M
7.         endif;
   
8.         wp_reset_query();
     b- k/ x. E9 B% ]7 _7 @
9.         return $return_string;
   
10. }

複製代碼

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


" D% f; ^: K, x1.2 註册短代碼
8 f( Y5 u. K" M) S# t現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   $ g. N& P3 j. a6 d+ m
2.         add_shortcode('recent-posts', 'recent_posts_function');
   
3. }

複製代碼

當在文章的內容中使用短代碼
# M; J5 k" \0 O0 ]7 Z; w1 o% y

1. [recent-posts]

複製代碼

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

( n5 K" S: b$ W# |' c
1.3 Hook into WordPress
! V) q& z2 {6 C: N9 `. W3 v* l- ~
為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。

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

複製代碼

5 r* [3 m$ x3 ^& H1.4 測試短代碼
6 l/ n8 I3 |6 {5 `7 ?3 t# F" k) e& U$ q簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   ; e7 Z( M% h) W- F% k
2.         extract(shortcode_atts(array(
   * i6 t) c: ~( t" t9 A5 x5 W
3.                 'posts' => 1,
   2 z% r, G0 k  V+ y8 ~# h' w" }
4.         ), $atts));
   % ^/ T* V$ q7 ~- Z
5. 
   
6.         $return_string = '<ul>';
   
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   * H( m7 K* ~2 |. h, m) y, G
8.         if (have_posts()) :
   + K$ n9 T5 g% s
9.                 while (have_posts()) : the_post();
   . G3 E+ ~4 x) U# ?
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
11.                 endwhile;
    
12.         endif;
    9 R* y5 Z" Z2 _( E5 f
13.         $return_string .= '</ul>';
    1 u# {8 @+ Y8 w7 n4 Z4 E( }
14. 
    
15.         wp_reset_query();
    + V) u' _& c  F1 r
16.         return $return_string;
    + `  v7 B# L) c( P9 b4 w& J  C
17. }

複製代碼

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

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

複製代碼

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

  V2 m0 p* R: ~) @2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   
4.         ), $atts));
   " a1 i; e1 f) Y$ Z9 X& j, K3 |
5. 
   5 g" S& d3 @) T* u! T  x
6.         $return_string = '<h3>'.$content.'</h3>';
   . W3 P; }1 B, Y( Q" K
7.         $return_string .= '<ul>';
   ; A4 {- S& M4 a! D4 T6 Y/ j
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
9.         if (have_posts()) :
   ; U1 c" w# s4 a
10.                 while (have_posts()) : the_post();
    : y/ Y9 m9 C' f0 F: \, w) o. c
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    : G* D% o# n: Y( S: W# w, o$ a
12.                 endwhile;
    : g, Y, ^( ]/ A0 ~% z* ?% {
13.         endif;
    " B. W( J. E! N% p$ |
14.         $return_string .= '</ul>';
    
15. 
    " r- L  \( ]! A, b, r6 n* w
16.         wp_reset_query();
    5 Q6 T* p' S9 @/ G: c
17.         return $return_string;
    
18. }

複製代碼

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

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

複製代碼

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

& Y8 i$ Y5 m/ z

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編輯器增加短代碼按鈕
/ D" L- Q" E% G# Y9 A" ^! S  X
8 f" C3 p/ V8 S5 t; H+ F) Q- V雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。

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

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

/ k3 h. A# u5 R4.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', {
   * Q! L/ g) d# N' Z) N
3.                 init : function(ed, url) {
   , {: i  H4 _) \( {8 m. {& S
4.                         ed.addButton('recentposts', {
   $ l  V, v1 n7 D( L7 K
5.                                 title : 'Recent posts',
   $ {; X8 P* U% f' d5 H, |  M( _
6.                                 image : url+'/recentpostsbutton.png',
   : }: g' `% q7 ?1 S
7.                                 onclick : function() {
   
8.                                         var posts = prompt("文章數量", "1");
   # z" h5 E5 ~; r" [; g5 y
9.                                         var text = prompt("請填入列表標題", "最新文章");
   . _- {5 \# [# |! j: g
10. 
    
11.                                         if (text != null && text != ''){
    2 @1 c, g; q# w+ L
12.                                                 if (posts != null && posts != '')
    + {6 q$ q# P% m: d4 M
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    
14.                                         else
    
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    2 V+ m: K; l% D" \4 f
16.                                         }
    
17.                                         else{
    
18.                                                 if (posts != null && posts != '')
    ' N# u8 f3 G3 u$ {
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    4 ^% l7 Z( N0 o
20.                                                 else
    
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    4 N$ ^. ^3 q4 v$ N+ S. d
22.                                         }
    ) P- c$ C; e0 A) z: Z6 _) X5 D" u
23.                                 }
    
24.                         });
    
25.                 },
    2 {# T+ z% N. B1 A" Q
26.                 createControl : function(n, cm) {
    ( s& u$ q" o2 n0 @
27.                         return null;
    % G' Y' ^2 M7 ~' E- K1 M: E
28.                 },
    
29.                 getInfo : function() {
    
30.                         return {
    , b$ b0 q2 t: C
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    
33.                                 authorurl : 'http://9iphp.com',
    
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    
35.                                 version : "1.0"
    % m& u( U% b) Y6 [+ T
36.                         };
    ; s( J# @* p8 w" ^( A" Q. `
37.                 }
    , @7 _0 v; A5 i8 @( ^
38.         });
    , K7 G5 ~" l( T
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    $ l' K5 O) B2 j* W
40. })();

複製代碼

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

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

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

4.2 註冊按鈕及TinyMCE插件

' Y  C1 K0 w* Y# C

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

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

1. function register_button( $buttons ) {
   1 ~7 @& W, t4 r. s9 e
2.         array_push( $buttons, "|", "recentposts" );
   5 |7 I5 [/ w) m0 [
3.         return $buttons;
   6 c3 @0 b0 A" c+ r! Q/ [% f/ _
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
; w& X7 H7 B# K/ f  n

1. function add_plugin( $plugin_array ) {
   
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   
3.         return $plugin_array;
   ! n1 ]& ]& }* E0 ~& G" H9 Q
4. }

複製代碼

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

1. function my_recent_posts_button() {
   * f& }' T2 f) h  A/ m1 Y% E
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   / ^4 W) n- {7 @
3.                 return;
     E) B" {0 v/ @2 }) H! N2 z
4.         }
   + L) s' [, b* p9 E
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   5 m8 T/ ]8 C) v2 s! Z' C; B- K
8.                 add_filter( 'mce_buttons', 'register_button' );
   
9.         }
   4 a0 G& {+ R1 d( m/ T
10. }

複製代碼

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

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

複製代碼

4.3 按鈕的用法

, ]$ ~* x9 i% v

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

  s/ O0 t$ y' h" f: ~: z( F

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

4 v4 r7 _! J5 p- k; t5 H2 o6 T

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

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

& B% z  b$ I  W. X. q

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

參考文章: 1 2