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

IT_man

tid=39737&WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
" n1 H  W* |) ?7 C6 v
wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
0 i0 R5 G; T# H( u* E/ G以下是 wordpress 短代碼的詳细介紹及進階應用。

9 `2 G' b" M# B, K5 ^短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
5 i2 C. W6 B3 q

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
( N3 r# {5 r: Z

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
  D' c/ K' O- {+ v$ l3 t! g- e

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

複製代碼

1. 簡單的短代碼
& l0 U" |* N& d2 p本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
, R9 v) r( B  Y  A

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
* \: g( \6 W1 h( U% `

• 建立一個函數 , 當 wordpress發現短代碼時會呼叫此函數 ;
• 藉由設置一個唯一的名稱來註冊短代碼 ;
• 把註冊的函數連結到wordpress的action上。
  5 B& r" v) W+ [! F# t

本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
& g7 g; P. Z$ c1 E+ g0 d0 ~! V1.1 建立返回函數
當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
6 a7 [& T  [2 w( L$ G: z9 W

1. function recent_posts_function() {
   
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   % m# o: Z. j  k7 G0 I
3.         if (have_posts()) :
   
4.                 while (have_posts()) : the_post();
   ! B8 J- v( W- j( z! u
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   * F. x, |% L! C% G% P$ n; R: t" c
6.                 endwhile;
   
7.         endif;
   
8.         wp_reset_query();
   9 r) k! Z2 D$ J+ N% c
9.         return $return_string;
   
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
- J+ Q9 Y8 l$ d% `
8 o+ ?& _6 |, E" c  {9 g8 j
- w' Z9 t' I. l; R6 F) r" z! V! {1.2 註册短代碼
( p# Y  t$ ?* x5 G5 y現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   - r9 ^5 ~# r; `1 h) ^' G
2.         add_shortcode('recent-posts', 'recent_posts_function');
   & I: m; h8 M; U2 P6 Q
3. }

複製代碼

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

1. [recent-posts]

複製代碼

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

1.3 Hook into WordPress

為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
# @) g/ R$ _  w+ w$ X7 z, w" e

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

複製代碼

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

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   
4.         ), $atts));
   7 a) p7 C3 J$ r2 N# o
5. 
   
6.         $return_string = '<ul>';
   9 @% N' s/ C: c$ l7 y1 U8 u# g9 i* \
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
8.         if (have_posts()) :
   & ?" U4 @( O1 D
9.                 while (have_posts()) : the_post();
   
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    . x& Y, }# {1 J9 X* y2 j' b
11.                 endwhile;
    4 o9 D% f0 B. a  S" a# m" }6 B
12.         endif;
    ; [$ Z5 @$ X2 e
13.         $return_string .= '</ul>';
    
14. 
    
15.         wp_reset_query();
    ! m: V, _6 N& a8 J
16.         return $return_string;
    ! `5 I) J3 f$ y1 y
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 T+ {5 s9 |3 I' r" Y3 }* m& {  \/ \7 M
6.         $return_string = '<h3>'.$content.'</h3>';
   ! e" \9 n0 O' E4 E( Z
7.         $return_string .= '<ul>';
   
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   8 u6 c+ }0 T9 U( v
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    6 I  S: i. Y  w2 O. p& I3 E
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    3 z5 M& v5 f) b; @
12.                 endwhile;
    , U  x* m+ L: j- u/ y% \' c
13.         endif;
    4 i4 A! c3 \# l  z
14.         $return_string .= '</ul>';
    # O9 C. U5 E. O$ x
15. 
    ' I4 U2 I+ t# n8 P5 o
16.         wp_reset_query();
    
17.         return $return_string;
    
18. }

複製代碼

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

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

複製代碼

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

4 F! x- C) M& e4 p- _6 i) L  z

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

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

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

- I- g2 S2 j# o+ A/ O  U

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

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

複製代碼

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

  U' e" }( W# n1 e

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

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

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

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

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

+ I) S3 H5 z: W! c+ u" u( K4.1 透過JS文件來建立按鈕

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

1. (function() {
   / t4 t- x, j1 M4 K* O* G5 M
2.         tinymce.create('tinymce.plugins.recentposts', {
   ) J5 t0 G4 e  Y: n. [- f! u6 K
3.                 init : function(ed, url) {
   
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   3 B: R/ R- [0 S
6.                                 image : url+'/recentpostsbutton.png',
   ; y! m# M/ y& S% Q9 ]3 l
7.                                 onclick : function() {
   . n7 M' J! q+ h4 x
8.                                         var posts = prompt("文章數量", "1");
   9 y8 O% G- F0 [4 W- y, m
9.                                         var text = prompt("請填入列表標題", "最新文章");
   
10. 
    1 u4 n' w4 z, l- U
11.                                         if (text != null && text != ''){
    
12.                                                 if (posts != null && posts != '')
    8 `5 i6 P- X7 N  K
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    0 _6 I9 \( a4 G4 O  u! V# M
14.                                         else
    
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    
16.                                         }
    
17.                                         else{
    
18.                                                 if (posts != null && posts != '')
    
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    
20.                                                 else
    ' q8 w8 t- J2 ~5 B6 l6 U
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    ' S& g! H1 Q1 A$ S  {. B
22.                                         }
    + X% d3 x" `/ C. n: I0 A; Q
23.                                 }
    
24.                         });
    2 R0 E: X& T, y0 d4 r
25.                 },
    ! O4 @# N9 v4 c: j0 I0 m0 o/ @
26.                 createControl : function(n, cm) {
    
27.                         return null;
    
28.                 },
    
29.                 getInfo : function() {
    
30.                         return {
    
31.                                 longname : "Recent Posts",
    . H6 S# O0 V! N/ z8 ?) R4 U2 j7 N
32.                                 author : 'Specs',
      V7 Y; \. n! R$ D% {4 D
33.                                 authorurl : 'http://9iphp.com',
    & H6 J* @. C- [
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    ' l7 B0 I& y; |7 X) i9 D
35.                                 version : "1.0"
    ! v' |% i* ?$ L. q3 I" R0 C
36.                         };
    5 Y: H; i1 b- Z3 E
37.                 }
    
38.         });
    
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    , }  e# G5 c, i$ Z7 W# j$ h) B7 O
40. })();

複製代碼

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

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

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

: e  d( n! Y) X8 o: l* u/ `2 T- \6 F

4.2 註冊按鈕及TinyMCE插件
5 x8 t$ D8 @  O! |

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

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

1. function register_button( $buttons ) {
   0 R7 d, \5 u8 o7 ~8 M
2.         array_push( $buttons, "|", "recentposts" );
   
3.         return $buttons;
   - L6 z4 B4 a/ o
4. }

複製代碼

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

1. function add_plugin( $plugin_array ) {
   , ]4 U: F( S+ k$ b. T% b3 a
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   
3.         return $plugin_array;
   ; Q9 L9 P8 t# ^
4. }

複製代碼

下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。
$ I' Q: B' h: f% `' K- T+ `

1. function my_recent_posts_button() {
   2 _- v0 Y; B; U+ c
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   8 A5 ]% }3 i' w% Y0 v1 P5 N
3.                 return;
   . @& g2 |0 B7 v8 F5 n. t
4.         }
   / v9 B# r  K4 P+ D5 L" H0 O
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   # _/ D( n2 M7 v0 j# l
8.                 add_filter( 'mce_buttons', 'register_button' );
   / [6 K; x7 i* x- A
9.         }
   # Z  c6 P  X/ Z* Y0 n  S6 i1 D
10. }

複製代碼

當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
+ Z. @' J& z/ v6 S; q- X最後把函數勾到Wordpress初始化函數

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

複製代碼

4.3 按鈕的用法

3 o( l9 S& F  Y* y

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

' f2 ~9 @6 X7 T

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

' S0 Y; h6 b: ~* ^5 ^! R

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

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

+ g! r- J( l% {) N2 L

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

參考文章: 1 2