52AV手機A片王|52AV.ONE

標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕 [打印本頁]

---

作者: IT_man    時間: 2016-6-9 12:40
標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕
WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
! J" H" ^5 _" x# G$ I0 [
+ e0 Q/ a, i% [4 W" a1 c$ fwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
以下是 wordpress 短代碼的詳细介紹及進階應用。
, i2 t) _* e3 }' Z& S
% F. X2 c: \- k短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
# S6 K0 o8 A9 ~

1. [recent-posts]

複製代碼

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

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

複製代碼

此外 , 我們也可以為文章列表新增一個標題 :
2 V4 u: C8 p! ?/ S5 l8 ^7 \

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

複製代碼

; C! T$ S; u+ O1. 簡單的短代碼
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
2 D7 i. m0 c0 o1 T% F- g$ g

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

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

1. function recent_posts_function() {
   
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   & L2 R7 g$ ^9 e$ f
3.         if (have_posts()) :
   2 H2 K; x& R2 _# D, n
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   # J2 `# A6 p9 O% W
6.                 endwhile;
   ; e/ a+ S" i2 q0 G
7.         endif;
   1 {+ i4 X/ R  g7 a% H$ f
8.         wp_reset_query();
   
9.         return $return_string;
   $ y$ }/ `# l. o; e$ x. |
10. }

複製代碼

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

+ K) U. G. k6 t- \
1.2 註册短代碼
/ K! s( `+ I/ _) J9 j0 ^& K現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   9 E2 l. W* c, c, `9 D
2.         add_shortcode('recent-posts', 'recent_posts_function');
   
3. }

複製代碼

當在文章的內容中使用短代碼
" F; ?7 n+ o) J: A" Y! `1 e5 N

1. [recent-posts]

複製代碼

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

" d. P. }' R  R' O1.3 Hook into WordPress

為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
3 m0 U3 V9 Q; |7 M( z8 Q

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){
   ! w1 j* X" o9 x7 l  z6 j" r: _
2.         extract(shortcode_atts(array(
   * b! [) y2 e) P& ?2 @' D
3.                 'posts' => 1,
   
4.         ), $atts));
   
5. 
   $ m& R' M$ G4 p. p# l# [3 z0 ]/ ]9 l
6.         $return_string = '<ul>';
   
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   8 z: R  L4 Z) F0 w8 r/ {) q& h2 b# z* _
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    
11.                 endwhile;
    9 @; ~3 D' u9 g3 K- w4 Q5 ^" ]+ C4 ?
12.         endif;
    
13.         $return_string .= '</ul>';
    
14. 
    * S* K  J* A0 l) X9 q) x
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) {
   ) I3 r7 b! S* x! S' E+ P
2.         extract(shortcode_atts(array(
   & Y% R3 C" p3 ^- b" P
3.                 'posts' => 1,
   6 v# z$ i' W# P  G* N5 M
4.         ), $atts));
   
5. 
   
6.         $return_string = '<h3>'.$content.'</h3>';
   $ |3 {4 O( V, S/ u
7.         $return_string .= '<ul>';
   
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
9.         if (have_posts()) :
   
10.                 while (have_posts()) : the_post();
    2 S1 m5 Q% G: d" f& P$ u0 ]- ~( O
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    ) b1 R3 R. N- n4 k: u5 |; F6 ]
12.                 endwhile;
    ' x: p: \% {7 T. C. h4 K
13.         endif;
    7 y; x8 {0 x( c: \; {$ r* |
14.         $return_string .= '</ul>';
    9 D: Y3 b7 O, K0 o4 V: ?( s
15. 
    ' ^9 a. n& V2 j# ^8 ~1 t# ]! s0 e9 S
16.         wp_reset_query();
    " n# Z+ W- x( s* g% m
17.         return $return_string;
    
18. }

複製代碼

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

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

複製代碼

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

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

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

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

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

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

複製代碼

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

7 e& p9 y7 `2 L8 u

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

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

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

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

0 K; o  \( }. }( g+ B4.1 透過JS文件來建立按鈕

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

1. (function() {
   . Q) i. x6 t4 y! H  ^& X& c6 i
2.         tinymce.create('tinymce.plugins.recentposts', {
   
3.                 init : function(ed, url) {
   
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   $ x0 y! n4 a/ p* \9 X. H- D; f# p
6.                                 image : url+'/recentpostsbutton.png',
   
7.                                 onclick : function() {
   
8.                                         var posts = prompt("文章數量", "1");
   5 b% l* C4 p. R3 @; c" T$ g
9.                                         var text = prompt("請填入列表標題", "最新文章");
   
10. 
    5 n& A! [* I6 K+ r0 M* B3 ]
11.                                         if (text != null && text != ''){
    & [# D% R3 w5 R& j
12.                                                 if (posts != null && posts != '')
    ; e$ L7 G7 r# W, @4 z, C/ ^3 z
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    
14.                                         else
    5 e* [; T$ Z7 e$ g
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    
16.                                         }
    ) j( ^2 l( q5 l4 V* _) Z/ d( x
17.                                         else{
    
18.                                                 if (posts != null && posts != '')
    - B' ^0 ]4 f9 n7 J  `
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    
20.                                                 else
    
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    / H. u0 {1 Y+ u4 E, Z
22.                                         }
    
23.                                 }
    
24.                         });
    / s: w/ C! L0 ~/ y( @4 p
25.                 },
    8 y4 E4 ?) J1 J4 j* u" @
26.                 createControl : function(n, cm) {
    ( t6 E9 ~9 c! E
27.                         return null;
    1 I, I0 z+ `& i$ j9 ?; I' w" ~) M
28.                 },
    & O( [. O0 K8 }7 S& {2 |0 L# o
29.                 getInfo : function() {
    ) q% Y; o  B8 f" a/ r/ }9 \0 Z
30.                         return {
    
31.                                 longname : "Recent Posts",
    
32.                                 author : 'Specs',
    - P0 n/ P: }+ \$ e( w) T+ i+ t
33.                                 authorurl : 'http://9iphp.com',
    + r1 B5 {; Y+ v6 A  p
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    ( ~( c  f, Z) U
35.                                 version : "1.0"
    
36.                         };
    
37.                 }
    6 c$ s# r5 p/ d! C% o0 y1 {) |
38.         });
    * b7 z! x1 f/ p6 T
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    
40. })();

複製代碼

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

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

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

4.2 註冊按鈕及TinyMCE插件
6 v4 Y" U! G# h% W0 w0 k1 o; N
& K/ V# A- {" g6 m$ T- A

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

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

1. function register_button( $buttons ) {
   
2.         array_push( $buttons, "|", "recentposts" );
   2 s% z* P( M% e& u$ A2 F
3.         return $buttons;
   
4. }

複製代碼

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

1. function add_plugin( $plugin_array ) {
   ; ^8 f4 V. m& O
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   
3.         return $plugin_array;
   2 F& |5 g( |. p6 k
4. }

複製代碼

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

1. function my_recent_posts_button() {
   
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   
3.                 return;
   
4.         }
   1 u$ r0 a, ]( Z% F" U3 r- c/ Y
5. 
   % |& ^4 q" U2 o9 T4 u
6.         if ( get_user_option('rich_editing') == 'true' ) {
   & a) l1 o; T# ^6 e; ~
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   
8.                 add_filter( 'mce_buttons', 'register_button' );
   
9.         }
   
10. }

複製代碼

當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
/ W" k- b& P5 T6 c5 s6 B最後把函數勾到Wordpress初始化函數

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

複製代碼

; P3 l+ [* g! C3 ?% P0 H4.3 按鈕的用法

% j7 w3 h  h* ^7 l  n& W0 {0 P  h

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

/ [6 }* s( g$ D9 N, L4 O

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

  d# Z/ H5 S' m% J3 P3 I# D5 |

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

$ y, c/ A. z8 X# t3 P( e

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

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

參考文章: 1 2

---

歡迎光臨 52AV手機A片王|52AV.ONE (https://nhkie.com/)

Powered by Discuz! X3.2