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

IT_man

WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
  t* X+ z& |( m; [! _7 ]
( z& E4 `8 n) }3 s( U2 \5 |wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
8 L, k  n' W% Z3 ]以下是 wordpress 短代碼的詳细介紹及進階應用。

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

1. [recent-posts]

複製代碼

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

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
; p9 M4 z; @; L8 b& ?

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

複製代碼

. @5 W7 a7 O) P7 [% @1. 簡單的短代碼
' w" o; n- c( |: p6 y8 F- ^0 ?本教學的第一部分 , 我們會建立下列短代碼的程式碼 :

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
8 j) D) D2 K' }& [( H% v

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

8 v: V6 g% A% j" g8 ~- S本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
0 b) z; o2 I3 _% S* e1.1 建立返回函數
當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
4 ?' l( j% a: d. \0 R# {! o  z

1. function recent_posts_function() {
   
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   
3.         if (have_posts()) :
   8 U3 h7 ?* B$ H% ^9 G$ ]9 |
4.                 while (have_posts()) : the_post();
   + t- D7 Z5 a% |( @( S( \
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   & E" A/ G9 F. @5 C3 N, c* r+ ~
6.                 endwhile;
     j, A  E4 p0 m5 d) W
7.         endif;
   
8.         wp_reset_query();
   
9.         return $return_string;
   
10. }

複製代碼

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

9 v' V: Q; T+ ~5 v
1.2 註册短代碼
現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   5 _2 v& B( v& I& s# a% X6 j# x
2.         add_shortcode('recent-posts', 'recent_posts_function');
   
3. }

複製代碼

當在文章的內容中使用短代碼
$ Z' g& P1 n7 N! I' O$ F' U+ o

1. [recent-posts]

複製代碼

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

" z  c7 E! Z" K4 _4 p4 ^6 S
* x% S4 o# ~  h0 j5 v- ?! Q1.3 Hook into WordPress
0 \. V% v! B8 m" k) p* p* t- V1 G
" T8 z! x' u' V7 g8 w+ T為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。

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

複製代碼

4 J- B1 |0 E7 ]4 j) q0 J1.4 測試短代碼
% N6 H6 S0 Y9 @; a6 {5 A8 ]簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   * n( o$ N1 n  A! A
2.         extract(shortcode_atts(array(
   5 @4 ]2 R. K, r5 j3 y
3.                 'posts' => 1,
   4 ~4 A$ D" w5 u% ?) l" D
4.         ), $atts));
   7 C; D% H# ?# R; {  Y$ U+ ~: X# n
5. 
   4 l& P4 e0 y# _3 E
6.         $return_string = '<ul>';
   7 H; \5 Q5 l+ @# h$ i: H$ s# }, X
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   7 Q1 {! H  |0 I
8.         if (have_posts()) :
   8 O, L6 R  r- c4 T
9.                 while (have_posts()) : the_post();
   
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    , [6 a) t0 H. S/ T% T: G
11.                 endwhile;
    1 \0 i, X8 D+ r& Z1 t0 N
12.         endif;
    1 g* i$ ^' l7 J  A# [/ X( ~: Q) L9 _4 u
13.         $return_string .= '</ul>';
    ( h4 H9 M$ k  g" R2 G! Y" o% g
14. 
    
15.         wp_reset_query();
    
16.         return $return_string;
    , V3 N. H3 [: L/ ~) o% F1 v
17. }

複製代碼

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

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

複製代碼

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

2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   
2.         extract(shortcode_atts(array(
   % A0 p0 a4 U- E, [! w! d8 I8 [
3.                 'posts' => 1,
   # T3 q+ R# g& V2 s- n
4.         ), $atts));
   
5. 
   
6.         $return_string = '<h3>'.$content.'</h3>';
   
7.         $return_string .= '<ul>';
   
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
12.                 endwhile;
    ( U& V2 ?& s, {0 J, h7 l% M5 k
13.         endif;
    
14.         $return_string .= '</ul>';
    
15. 
      m6 P% u9 c. M$ w: R: B( G0 K
16.         wp_reset_query();
    
17.         return $return_string;
    
18. }

複製代碼

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

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

複製代碼

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

8 P( }% J3 K& C  Y/ ^- X+ P

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

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

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

" E/ |8 ~( [/ Q, I- I+ }* X2 h& `& s

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

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

複製代碼

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

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

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

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  % ^9 z" q2 K: D% r4 f2 z: h2 e

3 H) I) t; [$ e5 c( s" L5 ~) D4.1 透過JS文件來建立按鈕

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

1. (function() {
   & b4 d1 {6 d0 f5 ^0 A
2.         tinymce.create('tinymce.plugins.recentposts', {
   
3.                 init : function(ed, url) {
   
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   
6.                                 image : url+'/recentpostsbutton.png',
   + C! c( p5 [' d; P/ }' r
7.                                 onclick : function() {
   
8.                                         var posts = prompt("文章數量", "1");
   ( K2 s8 d; g% I* a3 h
9.                                         var text = prompt("請填入列表標題", "最新文章");
   7 E' b6 r+ ]* n$ H1 a. s
10. 
    
11.                                         if (text != null && text != ''){
    ! {! B$ A2 U. y  l
12.                                                 if (posts != null && posts != '')
    $ \+ ~/ N& ~" J9 C, R3 ]
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    & ^3 M; p# R  k% p7 ]7 a, y2 j
14.                                         else
    0 ^+ k; H, Y2 x
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    % c9 K+ q! t; o3 J
16.                                         }
    . v+ H- F# J1 K, R$ u) e
17.                                         else{
    
18.                                                 if (posts != null && posts != '')
    , S, E: y+ ]- Q7 x& I' @
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    0 T4 ?. d: ]5 Y: @5 B) X
20.                                                 else
    
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    5 u! K# w6 [$ K: v0 o( G8 `1 G
22.                                         }
    5 n9 R1 S1 T. _' y8 p
23.                                 }
    $ W: m" ]1 w& B7 K4 ?
24.                         });
    
25.                 },
    
26.                 createControl : function(n, cm) {
    . C3 g+ h0 c* W8 T; G
27.                         return null;
    ( V: S. D* A% a) p1 p6 ~- S* w9 d
28.                 },
    & k8 o* D. K/ t8 M0 u
29.                 getInfo : function() {
    
30.                         return {
    ( b! S; a& t3 P
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    
33.                                 authorurl : 'http://9iphp.com',
      e7 z$ v' |% J2 @. `4 u# {  m! X
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    
35.                                 version : "1.0"
    4 m; G/ v7 W4 w) d& S
36.                         };
    
37.                 }
    
38.         });
    3 A! J& J+ i- n7 `0 I
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    
40. })();

複製代碼

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

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

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

# D. G! d' v2 b% v

4.2 註冊按鈕及TinyMCE插件
% U; a( H7 a- B% V0 A
' u  w0 I3 w* u0 I1 E  Q1 Q5 b

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

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

1. function register_button( $buttons ) {
   
2.         array_push( $buttons, "|", "recentposts" );
   9 @% d8 T$ J% a' B3 b& l
3.         return $buttons;
   
4. }

複製代碼

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

1. function add_plugin( $plugin_array ) {
   6 E+ t2 f- @7 n. j
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   # T+ R3 h% M" m5 [* W8 d0 w, }% R
3.         return $plugin_array;
   ' _! ?! V+ p+ w
4. }

複製代碼

下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。
+ {- G  \- R. U% t: u8 E4 y

1. function my_recent_posts_button() {
   # Z+ W* y! [, S' j) @
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   + G, ^% v' ?( A& B" m
4.         }
   
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.         }
   2 W, i) a8 H* c7 C, K2 ~% k
10. }

複製代碼

當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
3 c7 b& e  c5 d1 P; B最後把函數勾到Wordpress初始化函數

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

複製代碼

4.3 按鈕的用法

6 e* B/ Q, j# j$ `* f# p

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

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

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

( b4 `- T+ k$ j* N

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

% L- L4 ^" R; T

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

參考文章: 1 2