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

IT_man

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

wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
, T" W' u/ v' B4 ^以下是 wordpress 短代碼的詳细介紹及進階應用。
  e" M9 Q2 B8 K) v5 d/ K
" e8 c: v$ Y( B# o& N短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
6 Q, s- @  j8 d' |

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
3 ]4 }, e5 h5 U( B

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

複製代碼

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

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

複製代碼

* h' G; ^& k# b' J+ ?0 k1. 簡單的短代碼
4 Q6 p4 l3 V) J- `  g& P& O本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
8 k- S) V; m+ t$ l; p6 N" g

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :

• 建立一個函數 , 當 wordpress發現短代碼時會呼叫此函數 ;
• 藉由設置一個唯一的名稱來註冊短代碼 ;
• 把註冊的函數連結到wordpress的action上。
  5 C: W/ D  L, C$ U% c

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

1. function recent_posts_function() {
   . d6 A- w( `; o2 h1 Z# j
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
     r( z* ?3 t9 n& G
3.         if (have_posts()) :
   5 }( H# I4 `& N& G
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   
6.                 endwhile;
   0 I! [# U# R2 ?5 J0 R+ F, B2 W  V
7.         endif;
   
8.         wp_reset_query();
   & x( B7 Q; k& y  @
9.         return $return_string;
   5 |0 x) y- a! `. _' e9 F7 n" H
10. }

複製代碼

如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
& d6 r) H& m/ a6 ?; n; k, C  @

1.2 註册短代碼
+ K. A7 K4 e7 L2 u( {/ ?4 B現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   $ ^# z$ S4 z4 o
2.         add_shortcode('recent-posts', 'recent_posts_function');
   % }, R% h& T  S2 I
3. }

複製代碼

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

1. [recent-posts]

複製代碼

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

, @: f+ r$ T; c! D, e: P  z
( I! H: d% H5 v: s! i- Q1.3 Hook into WordPress
8 o/ g! M: \+ _0 }5 l3 d
& h8 B* I; g" o  X# |- c為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
, M' I" {6 M+ w/ ^. S

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(
   % x) b9 ?( g; v
3.                 'posts' => 1,
   8 e+ n' K( ]+ M& |# N* K, W
4.         ), $atts));
   
5. 
   
6.         $return_string = '<ul>';
     J# i3 G8 _4 s
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   % z- O' G) F, f
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
11.                 endwhile;
    
12.         endif;
    
13.         $return_string .= '</ul>';
    9 F- m/ V# z6 `( i( F% W2 @8 I, X
14. 
    9 \$ W' m& d' A0 j1 Y; o
15.         wp_reset_query();
    
16.         return $return_string;
    0 w2 f6 a2 c. R, F& p9 v/ m1 S
17. }

複製代碼

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

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

複製代碼

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

2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   
2.         extract(shortcode_atts(array(
   - x* S$ I+ ?1 L- Q1 b3 E- p
3.                 'posts' => 1,
   
4.         ), $atts));
   + Y: R& F" d+ G( I6 n0 _
5. 
   
6.         $return_string = '<h3>'.$content.'</h3>';
   
7.         $return_string .= '<ul>';
   ; h7 C, z% Y; E5 ?
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
9.         if (have_posts()) :
   - G* k9 r6 H: V# s# C9 G4 Z& k
10.                 while (have_posts()) : the_post();
    
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    # X) o/ H- u  s- A
12.                 endwhile;
    
13.         endif;
    # {" ^+ i/ _9 ~' D" }1 m
14.         $return_string .= '</ul>';
    2 E5 |/ o7 X( j0 t+ e* p
15. 
    ; b' {0 Q7 _6 u- l. L8 l* i; u9 s
16.         wp_reset_query();
    7 n9 B' q' Q% Q- T$ R
17.         return $return_string;
    
18. }

複製代碼

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

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

複製代碼

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

# a7 [" {8 C2 H

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

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

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

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

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

複製代碼

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

) o0 y% R! r5 S' V- Y; [- d

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

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

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

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

) b, N2 u7 [0 \% l6 _+ O4.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) {
   ; k0 o6 G5 e( V$ r
4.                         ed.addButton('recentposts', {
   1 j7 {7 \9 ?5 a% U, o- m+ Q
5.                                 title : 'Recent posts',
   
6.                                 image : url+'/recentpostsbutton.png',
   # n) |7 e- ^; X, d, g3 b
7.                                 onclick : function() {
   
8.                                         var posts = prompt("文章數量", "1");
   $ c& j+ {1 q3 r# Q* h% {* W
9.                                         var text = prompt("請填入列表標題", "最新文章");
   ( V  _4 h4 A; g1 Q. b
10. 
    % `5 \- W' e: h% P; ?3 a- g
11.                                         if (text != null && text != ''){
    ; _) D' G+ F/ G4 ]5 _& x
12.                                                 if (posts != null && posts != '')
    
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    
14.                                         else
    6 P' s" I! E& u2 f9 P$ R' ^
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    
16.                                         }
    7 q9 s, g' I+ D1 l( T; @
17.                                         else{
    
18.                                                 if (posts != null && posts != '')
    
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    ' |0 N: Z* c2 Y$ F  I- o
20.                                                 else
    8 q6 R0 d7 u( @
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    ; w4 ?& {. @  b2 |4 [
22.                                         }
    * i8 u) o$ J/ c
23.                                 }
    # d, o9 q' x( d5 w
24.                         });
    . \  a- b5 `4 P/ B7 `4 A
25.                 },
    & m: H) L' E1 g# p
26.                 createControl : function(n, cm) {
    , W0 M( U" n. `$ c
27.                         return null;
    ; H7 k+ F: B- N8 p' I
28.                 },
    2 S4 j+ o8 G$ B+ L
29.                 getInfo : function() {
    / B" Z1 V: A4 H- D  O2 Q( s
30.                         return {
    - N9 u( \& w5 ^8 k4 J4 P, O
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    0 Y6 s7 Q4 `" Y" A% j3 R
33.                                 authorurl : 'http://9iphp.com',
    % m5 [* k& P2 L  `% N
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    $ L1 P# }4 W, m1 L" c0 z& \+ _+ x
35.                                 version : "1.0"
    : L# I4 {) j( [2 W
36.                         };
    
37.                 }
    & Q! h/ @9 L4 H; H. o
38.         });
    9 u/ ~! N, {+ s
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    3 o2 Q1 o) M/ P0 W/ w0 K& L
40. })();

複製代碼

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

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

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

, C4 L/ [3 W' y

4.2 註冊按鈕及TinyMCE插件

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

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

1. function register_button( $buttons ) {
   / [4 K6 H0 K8 t3 _- k
2.         array_push( $buttons, "|", "recentposts" );
   
3.         return $buttons;
   # f4 L. u# n0 X3 K- V" E5 o0 r6 m4 d
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
8 }4 \! _0 x2 p5 e! k' n; {

1. function add_plugin( $plugin_array ) {
   " n/ l& k$ D" t& ^# \
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   ; B7 ~0 v+ _. P0 g) j3 v8 t1 f
3.         return $plugin_array;
   0 T: Z5 y" m* H/ m3 q& ~
4. }

複製代碼

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

1. function my_recent_posts_button() {
   
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   ) {5 ]) J# Q( e. A. S' l# }- o
4.         }
   3 P8 \. V0 N+ l; [0 {0 U3 t# l6 ]
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   % F" J& B/ F/ H$ ]
8.                 add_filter( 'mce_buttons', 'register_button' );
   
9.         }
   
10. }

複製代碼

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

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

複製代碼

4.3 按鈕的用法

, P7 q+ M1 ~: U; g. z0 g( g0 `- x

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

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

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

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

# L4 c0 D7 k0 S5 o

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

參考文章: 1 2