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

IT_man

WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
  h9 f+ M2 l: V# ?! T
wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
9 O' P/ W6 [& [3 S5 |  k/ B以下是 wordpress 短代碼的詳细介紹及進階應用。

% T8 L% u0 }% L6 i, D$ U! a短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
3 A- _  l$ F. W

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
+ g/ ~8 I( f8 [4 U$ o. T

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :

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

複製代碼

/ Z  _2 x  ^, G1 g# g7 E
* j# Q" O' `9 C# o% O8 P1. 簡單的短代碼
, Z. H: d' ~9 F* l* b1 \& \本教學的第一部分 , 我們會建立下列短代碼的程式碼 :

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
& j+ p5 U* ^& T% V) r6 j8 E# w; T

• 建立一個函數 , 當 wordpress發現短代碼時會呼叫此函數 ;
• 藉由設置一個唯一的名稱來註冊短代碼 ;
• 把註冊的函數連結到wordpress的action上。
  - e- j5 |( R/ x& H, }" Q

本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
1.1 建立返回函數
- E* N. `% T2 u9 w當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
5 c! ]( U6 S) |, v

1. function recent_posts_function() {
   
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   " m3 Q0 s$ K' W8 i
3.         if (have_posts()) :
   0 O! ?+ J9 n; J5 F
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   * s" A' F/ Q" P2 a/ I
6.                 endwhile;
   % N8 m# H4 s: l9 _0 E
7.         endif;
   
8.         wp_reset_query();
   ( D5 V3 e# k3 W) q, [
9.         return $return_string;
     j" _5 V9 ~5 y$ l/ }: R
10. }

複製代碼

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


$ i0 L0 h5 O, n( O3 U1.2 註册短代碼
" Q  V% O% B1 c現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   & L4 x$ x4 V# X6 X" D9 N
2.         add_shortcode('recent-posts', 'recent_posts_function');
   # I0 f- m  _9 R" Z5 L6 d; S4 x) A
3. }

複製代碼

當在文章的內容中使用短代碼

1. [recent-posts]

複製代碼

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


# N/ h: i- C2 i& F4 S& _9 l1.3 Hook into WordPress
% N" F- B; t8 x+ K3 J
* H2 ~( L3 P- l2 A+ _7 o, E為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
3 y. p% I, I$ k( }; h: I

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

複製代碼

1.4 測試短代碼
6 n  E% S: f- `" D簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   
2.         extract(shortcode_atts(array(
   4 N# Z; K$ H$ B
3.                 'posts' => 1,
   
4.         ), $atts));
   
5. 
   : M( R4 k1 l! O3 Z' A
6.         $return_string = '<ul>';
   " S3 o4 {1 N# F( F1 R: [
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>';
    ; t2 E( n6 j) M& I% Z. q+ Q6 a0 j
11.                 endwhile;
    . u3 J6 u5 W$ v5 F7 u* E
12.         endif;
    / p/ i* `% a+ L0 ~$ t
13.         $return_string .= '</ul>';
    
14. 
    & i" x. v1 }" G( {& I) `
15.         wp_reset_query();
    
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(
   9 L& G7 N1 |" n% m' r: J! X
3.                 'posts' => 1,
   
4.         ), $atts));
   
5. 
   * e! y; P6 t7 `
6.         $return_string = '<h3>'.$content.'</h3>';
   5 G# i5 ^  Z1 F1 R* b- V
7.         $return_string .= '<ul>';
   
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   ( _5 Q6 M' b- D% f  _( V; g+ x
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    1 H; T, k- i$ l6 j# q/ |, C
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    : N7 r1 M, M5 J% m! \( m
12.                 endwhile;
    & t! s6 h% Z% d: D8 x& f
13.         endif;
    5 t. u6 w1 \9 [, ?- R9 L5 U
14.         $return_string .= '</ul>';
    
15. 
    
16.         wp_reset_query();
    
17.         return $return_string;
    * e9 m; p; v2 h/ W5 S, K2 a
18. }

複製代碼

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

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

複製代碼

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

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

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

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

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

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

複製代碼

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

& |  {; ]* M7 q+ N8 ?) H) T0 B. }" ?

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

4. TinyMCE編輯器增加短代碼按鈕
& x: s  l5 b( k- j
雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  2 f# E+ j  G; ?1 t, }

& t' x/ U3 p) D4.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) {
   
4.                         ed.addButton('recentposts', {
   % F  y2 h. j1 c3 J  [' l
5.                                 title : 'Recent posts',
   
6.                                 image : url+'/recentpostsbutton.png',
   9 v0 l( |  f9 v8 ]$ u' s5 @
7.                                 onclick : function() {
   + }$ t8 P( x, O7 {" `$ `
8.                                         var posts = prompt("文章數量", "1");
   
9.                                         var text = prompt("請填入列表標題", "最新文章");
   ' q& D- \. q7 E% F3 g
10. 
    
11.                                         if (text != null && text != ''){
    
12.                                                 if (posts != null && posts != '')
    " z2 x. ~1 A) N- t- J' p
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    
14.                                         else
    
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    
16.                                         }
    
17.                                         else{
    
18.                                                 if (posts != null && posts != '')
    ; {6 a" }2 i9 d
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    & X: w9 W1 z. G( B. L, N
20.                                                 else
    
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    : l7 Y$ o/ v9 r1 j1 B8 s. {
22.                                         }
    
23.                                 }
    
24.                         });
    , k1 E: i, ]- F7 N" |5 n
25.                 },
    2 R' b  d3 \! Z. L
26.                 createControl : function(n, cm) {
    
27.                         return null;
      k$ h( M; u5 V8 Y4 Z( Z
28.                 },
    % O! W# U. p2 _6 G4 }# f) o; p# ~
29.                 getInfo : function() {
    
30.                         return {
    7 s% T3 L7 R$ R* S) D
31.                                 longname : "Recent Posts",
    : j# S6 q. a8 @. }  P  E3 y1 L
32.                                 author : 'Specs',
    . ?: T: _# n2 V+ o$ v# a
33.                                 authorurl : 'http://9iphp.com',
    % E, `! {9 v$ E
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    0 ^' {3 s& L0 B" n" B
35.                                 version : "1.0"
    + M' C8 }* @/ \" E
36.                         };
    . X$ c& k0 w: R, w+ u2 c9 D" j( I' `
37.                 }
    
38.         });
    
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    7 p! {3 |* }1 D# k0 A
40. })();

複製代碼

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

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

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

4.2 註冊按鈕及TinyMCE插件
8 j9 c0 H+ r' J# ]$ l7 n

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

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

1. function register_button( $buttons ) {
   
2.         array_push( $buttons, "|", "recentposts" );
   
3.         return $buttons;
   6 w  H5 e: F: t( q2 o% i5 z$ A; ?
4. }

複製代碼

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

1. function add_plugin( $plugin_array ) {
   
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   1 J! n1 x+ e! A- B5 Z- A
3.         return $plugin_array;
   & e2 J' V, l8 r# m. r7 j  y
4. }

複製代碼

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

1. function my_recent_posts_button() {
   
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   - H6 z" [+ x) |% b" W
4.         }
   4 @0 L7 H4 m' v; G
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   0 H! U& Y3 @  K
8.                 add_filter( 'mce_buttons', 'register_button' );
   
9.         }
   ' ^4 D8 p4 _3 f. m' p
10. }

複製代碼

當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
) W, x- I* m: }3 V& b0 z最後把函數勾到Wordpress初始化函數

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

複製代碼

, {9 ^9 u% M% a) G, L  E* a4.3 按鈕的用法

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

& z# B+ o) G0 ?: G/ S  t; H

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

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

4 }8 |1 m% e. p( A8 w$ D8 U

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

: U' r" R6 [6 W, Q1 V

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

參考文章: 1 2