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

IT_man

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

wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
以下是 wordpress 短代碼的詳细介紹及進階應用。
1 G9 \8 p+ a6 O4 J+ J
0 r. Q; g0 Z* P% n短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
, l4 J$ L. [3 a- j. P! `0 i

1. [recent-posts]

複製代碼

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

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

複製代碼

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

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

複製代碼

" d7 X0 e' m6 E8 @, x
8 q+ j$ l% k: M3 A9 R; ^1. 簡單的短代碼
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
! i" t  d0 Q; Z2 h7 l$ e- l

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
# U! [9 k, ~* s$ {/ |

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

; N. x3 y/ }+ ?本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
$ C/ x# g4 Q! N6 L1.1 建立返回函數
' B/ S- D' Y7 H$ Y# q+ j當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
- ]" Y; M% E- M! ^7 o

1. function recent_posts_function() {
   
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   
3.         if (have_posts()) :
   ) t4 p$ p6 k0 i2 ?4 c7 X
4.                 while (have_posts()) : the_post();
   ! K5 W1 e& n6 O0 w- g
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   
6.                 endwhile;
   ; }8 j2 G+ l4 v- L
7.         endif;
   ( S7 a7 C- r7 z, g9 A; |# M! s' }+ M: ?2 O
8.         wp_reset_query();
   
9.         return $return_string;
   
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
- h' C( t  C- R$ ^6 A7 W
/ D: @8 R) l0 V! Y
/ j7 ?" t0 h# E& y/ B& o1.2 註册短代碼
現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   
2.         add_shortcode('recent-posts', 'recent_posts_function');
   6 F: R8 g% K* {* r% Q4 M$ t' P
3. }

複製代碼

當在文章的內容中使用短代碼
% v+ Z  `: Q. k  X- Z: |6 F6 u- U

1. [recent-posts]

複製代碼

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


1.3 Hook into WordPress

6 b4 e2 C- ~7 [6 q為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
; s+ W( Y7 f( c& T( y

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

複製代碼

1.4 測試短代碼
% y. l3 f% Y4 K6 N& }! y3 W簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   5 }! c* M6 K$ h9 p( Z) [  o* J
2.         extract(shortcode_atts(array(
   # m0 x  Y7 g- B! U9 X
3.                 'posts' => 1,
   
4.         ), $atts));
   3 c; H8 g) c: V+ `  Y7 q
5. 
   
6.         $return_string = '<ul>';
   
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   8 M5 w5 w" Z) j% ~" P
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    0 s$ u( S0 u3 |) }: b
11.                 endwhile;
    
12.         endif;
    
13.         $return_string .= '</ul>';
    - D* c$ q) O) c. Y( K
14. 
    
15.         wp_reset_query();
    
16.         return $return_string;
    $ U* w$ I) s5 P- @/ g( n9 p8 h
17. }

複製代碼

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

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

複製代碼

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

/ N5 n/ o* ~. W8 F- t- |7 K2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   
4.         ), $atts));
   ; l5 b& ?, R# ?
5. 
   
6.         $return_string = '<h3>'.$content.'</h3>';
   % j' J  w  Z1 O9 p
7.         $return_string .= '<ul>';
   - A- G4 G6 b7 L! n
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   8 r- N1 _& _0 H
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    5 m# w5 o5 H& G/ e1 s, |3 d: P. \
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    7 z0 x- p/ W; Z
12.                 endwhile;
    - x3 i# q" y3 X# A6 q* t
13.         endif;
    ) f  }  A6 |7 |9 s+ C. ?' S- [  T* ^
14.         $return_string .= '</ul>';
    
15. 
    & t7 a: ^! G# }! M9 X8 v
16.         wp_reset_query();
    8 C8 V" W% |& ^; K) V
17.         return $return_string;
    
18. }

複製代碼

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

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

複製代碼

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

5 _% S1 N( k% Q, m4 O

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

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

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

1 \$ d6 X, ~3 h; }

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

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

複製代碼

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

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

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

% w. W5 L. x* o4 \2 _雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。

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

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

. d, ~! H( z# f& N  B: I7 u/ E4.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) {
   % h4 p6 ?' P; u& E+ |
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   2 N0 D& L- S: z. s4 h+ A1 s9 B2 s5 B
6.                                 image : url+'/recentpostsbutton.png',
     j) T8 G  |, r9 P) k
7.                                 onclick : function() {
   
8.                                         var posts = prompt("文章數量", "1");
   
9.                                         var text = prompt("請填入列表標題", "最新文章");
   
10. 
    + l4 i8 Z. V/ ~& P
11.                                         if (text != null && text != ''){
    
12.                                                 if (posts != null && posts != '')
    # ]8 E4 s% X4 n' D
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    ( O% ~7 t- z# p$ E$ d' Z
14.                                         else
    
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    
16.                                         }
    
17.                                         else{
    
18.                                                 if (posts != null && posts != '')
    * ~, [4 m2 s2 _
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    * u6 i9 U; G9 L6 X# Y& u) X5 z3 f
20.                                                 else
    : O' S9 K* C. ^* g/ O5 }  X
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    
22.                                         }
    : `3 Y" f1 J' i: B% M+ N
23.                                 }
    8 [# ~9 G6 z9 A& ?1 e  V) G
24.                         });
    ( a3 F0 i4 J6 O2 l
25.                 },
    
26.                 createControl : function(n, cm) {
    4 f: V5 {! D3 i# M
27.                         return null;
    - {( v( W3 P$ K$ ^" c! [7 u  d
28.                 },
    : p4 v6 s% N, F; z
29.                 getInfo : function() {
    3 c/ ?4 C% |4 ~7 v' W" W. X0 j
30.                         return {
    
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    
33.                                 authorurl : 'http://9iphp.com',
    0 \, f7 d9 S% D( ~8 }7 q$ k
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    
35.                                 version : "1.0"
    
36.                         };
    
37.                 }
    
38.         });
    
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    
40. })();

複製代碼

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

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

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

3 j3 w) {3 f# ~# g2 \* x$ w& N

4.2 註冊按鈕及TinyMCE插件

: O/ v! d. ]' L% j0 E4 |. H

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

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

1. function register_button( $buttons ) {
   
2.         array_push( $buttons, "|", "recentposts" );
   
3.         return $buttons;
   0 k0 E! ]# M3 h4 Q! o8 T
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
  e0 u( o' v) `: Y- }

1. function add_plugin( $plugin_array ) {
   
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   
3.         return $plugin_array;
   , N: d* c. }  l* ]6 l# N7 e0 C0 [
4. }

複製代碼

下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。
/ ?2 a8 D' l2 ^. }0 t

1. function my_recent_posts_button() {
   * l+ o+ x2 g. [8 Q2 {9 R1 J( d, Z
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   
4.         }
   2 x# J* j3 j+ i& `6 G) w
5. 
   : K6 h( G! ?3 ], d, L2 t
6.         if ( get_user_option('rich_editing') == 'true' ) {
   * i5 U" Z# o6 C6 `) V& i0 \
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   : m  ^7 Q* c$ N: O( [, K  U/ w
8.                 add_filter( 'mce_buttons', 'register_button' );
   
9.         }
   
10. }

複製代碼

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

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

複製代碼

" g& u0 e" Y5 d; {/ `2 T4.3 按鈕的用法

& ?) `1 t) X+ D. n& O

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

3 Z( d* I9 |2 s( J) Q& E

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

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

  ^* v- g; k% y* @0 V9 X3 Y6 i. U' U

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

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

參考文章: 1 2