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

IT_man

WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
9 \4 q0 {) t% }( p5 m2 _' P" ~
wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
3 Y; u2 Q' F8 \5 Z3 S以下是 wordpress 短代碼的詳细介紹及進階應用。
% G; v( K0 R1 C; l8 H: g( Z3 z0 F
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
7 W* h  q7 L: m9 y* k( H

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
# e. Y+ o) Y! ]/ p% H

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

複製代碼

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

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

複製代碼

" G4 c4 Q" G/ N
! f( T/ M8 P6 P% G8 _+ U: p1. 簡單的短代碼
* s, L' a- J2 U& i# j! O本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
( {5 m# l. K$ ~

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
/ Z2 d5 w  d! Z9 |5 l& j; v0 v

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

* t4 G# p( i7 b& u2 w4 _本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
1.1 建立返回函數
' e; G2 t8 `% B  {5 o  I當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
0 n. n2 `3 `6 o) w

1. function recent_posts_function() {
     ?: i; _, J9 [+ `! c
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   4 Q! q; c! g" E
3.         if (have_posts()) :
   4 I. Z+ w8 |8 v2 e% H
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   
6.                 endwhile;
   
7.         endif;
   
8.         wp_reset_query();
   
9.         return $return_string;
   ) d, S! p  t4 M5 C  V- ?
10. }

複製代碼

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


1.2 註册短代碼
現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   
2.         add_shortcode('recent-posts', 'recent_posts_function');
   9 J3 P, {; M  Q: J8 p9 N0 a
3. }

複製代碼

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

1. [recent-posts]

複製代碼

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

0 Y, s. F, [8 w  j
1.3 Hook into WordPress
5 s- E, `8 z5 n9 x' N4 G# ]3 x
% M8 Z4 ~7 }! u  d為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
, ]: H- Y; B; t5 m

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

複製代碼

" n1 i. E% ~# b) w3 k5 p7 e1.4 測試短代碼
簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   + ]$ s- X% A( w( J+ r0 r
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   ( ?! T9 S4 B4 S# D- d' Q7 x
4.         ), $atts));
   , P: P1 k. [) ?- M0 e# \" e7 q
5. 
   
6.         $return_string = '<ul>';
   
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
8.         if (have_posts()) :
   3 S% P8 t' I+ Y4 N
9.                 while (have_posts()) : the_post();
   
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    4 o$ Z2 b" ]" p( m
11.                 endwhile;
    5 _, W! B. C' ?- S
12.         endif;
    
13.         $return_string .= '</ul>';
    7 N$ K$ V- [, e: O+ o
14. 
    
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(
   
3.                 'posts' => 1,
   
4.         ), $atts));
   
5. 
   
6.         $return_string = '<h3>'.$content.'</h3>';
   8 K" ?  P' p1 A( n2 G# d  d3 W
7.         $return_string .= '<ul>';
   ! f6 x" T; f3 Y' x
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
9.         if (have_posts()) :
   8 ^, B; B$ l; E$ Q6 ^3 P# S
10.                 while (have_posts()) : the_post();
    % P" v% S  [: J- C3 M2 X% h
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
12.                 endwhile;
    ; I' S- u4 E7 ]; X
13.         endif;
    
14.         $return_string .= '</ul>';
    
15. 
    
16.         wp_reset_query();
    . i5 Y2 m! W5 n" A  n; _
17.         return $return_string;
    
18. }

複製代碼

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

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

複製代碼

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

0 r- ^+ h) \" T9 l* ?

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

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

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

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

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

複製代碼

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

: j- K6 A4 J8 H; U

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

4. TinyMCE編輯器增加短代碼按鈕
# o! a2 a# X: j# J  p% V& `
9 A3 ~  ?" e* u1 M( I! ~. |雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。

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

• 為此按鈕建立一個 JS 檔案
• 註冊按鈕與JS文件
  . H  P+ _. U9 V, G" h& K

! _. R2 U5 z1 p! R  b4.1 透過JS文件來建立按鈕

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

1. (function() {
   3 Q. a) n9 I; c4 H
2.         tinymce.create('tinymce.plugins.recentposts', {
   ( c! n. a: {. d9 O
3.                 init : function(ed, url) {
   ' _) o3 F7 \- ]+ J
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   
6.                                 image : url+'/recentpostsbutton.png',
   
7.                                 onclick : function() {
   
8.                                         var posts = prompt("文章數量", "1");
   
9.                                         var text = prompt("請填入列表標題", "最新文章");
   
10. 
    
11.                                         if (text != null && text != ''){
    6 B5 n' @3 X$ t0 L; K+ U4 f
12.                                                 if (posts != null && posts != '')
    ! o* |1 X# ?+ D  K& D& D- |
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    
14.                                         else
    4 F3 N1 x+ a' p3 W- a0 B! z" f
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    1 [; }3 ^8 |/ i- Y
16.                                         }
    6 g" {0 r: L* J: R2 S' U% Z2 }
17.                                         else{
    
18.                                                 if (posts != null && posts != '')
    : O2 T( O. b  z% |, S
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    0 ?& G1 L& t9 x( g  @, {
20.                                                 else
    
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    5 Y+ L8 W/ ]% r' ]4 f
22.                                         }
    
23.                                 }
    ' W% ~$ j! M3 s, g/ A
24.                         });
    
25.                 },
    2 `- d0 ~( N# m& t& D0 D
26.                 createControl : function(n, cm) {
      O6 ]  a. ~2 E
27.                         return null;
    
28.                 },
    ) b+ ~  }. Z# p% m
29.                 getInfo : function() {
    1 r1 L, k4 x3 V$ t! K: J9 I" j
30.                         return {
    
31.                                 longname : "Recent Posts",
    , V% u/ V5 K) P  g9 k  [. \0 a8 Y
32.                                 author : 'Specs',
    
33.                                 authorurl : 'http://9iphp.com',
    
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    " N5 X3 A3 n9 k8 P
35.                                 version : "1.0"
    " R+ z) ]. Q6 S3 j0 o! t- C# G
36.                         };
    ) H7 R. z1 N1 x$ k+ L4 a
37.                 }
    & G. R6 Z7 s& b
38.         });
    0 r- p8 [3 }6 d6 E4 A9 }
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    
40. })();

複製代碼

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

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

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

4.2 註冊按鈕及TinyMCE插件

/ W. s0 c- m9 x) E4 x$ v" R: `- A4 r

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

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

1. function register_button( $buttons ) {
   % B/ G9 c0 E* T# t
2.         array_push( $buttons, "|", "recentposts" );
   3 y6 b! B4 w1 u3 `% G  m
3.         return $buttons;
   . C2 b+ N6 P! h# s
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
" W9 w* v/ A1 @0 l0 ~' p  P

1. function add_plugin( $plugin_array ) {
   
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   5 g1 P2 G; p5 A2 G: X
3.         return $plugin_array;
   
4. }

複製代碼

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

1. function my_recent_posts_button() {
   $ r4 q9 x6 Q8 h
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   + N; u  g( Y, s9 F
3.                 return;
   * R" l  y9 u- T( m  R
4.         }
   
5. 
   ; R& ?2 h0 z: a$ Y! n
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   
8.                 add_filter( 'mce_buttons', 'register_button' );
   " T1 z2 z9 _# U3 t
9.         }
   - Z$ j9 E& n( E9 N7 v) ]
10. }

複製代碼

當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
, Y5 A0 U/ s7 |+ f9 V5 S+ P最後把函數勾到Wordpress初始化函數

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

複製代碼

6 F$ L# s& H* o  G5 r- V* a4.3 按鈕的用法

* n- U, U2 d7 L

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

; u* d+ @2 \% T/ ?) ]5 h

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

! I% h% c; L: J) H& ^9 @

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

# F9 f4 F2 l. y0 @& u: K8 r' _

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

/ x& B6 f/ g' R& o& x7 u/ f

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

參考文章: 1 2