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

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

---

作者: IT_man    時間: 2016-6-9 12:40
標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕
WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)

3 \+ B5 [2 J1 Vwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
# \; x# n+ ^7 R# O以下是 wordpress 短代碼的詳细介紹及進階應用。

短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :

1. [recent-posts]

複製代碼

此外 , 我們可以設定一個參數來控制文章的數量 :
( d$ t7 U7 a+ h' J- v/ j

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

複製代碼

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

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

複製代碼

8 M  Z+ t6 V) g; r+ u4 g& F- ^& C
; T) I7 M2 l+ x0 Q/ c/ s6 L1. 簡單的短代碼
/ r6 f9 e1 e8 T; B" Q# j本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
4 R5 p! O, f3 U

1. [recent-posts]

複製代碼

該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
: K- E. j& @& ^. q7 Z) |

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

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

1. function recent_posts_function() {
   
2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
   
3.         if (have_posts()) :
   : `7 N5 E+ h$ L, [4 G
4.                 while (have_posts()) : the_post();
   
5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
   
6.                 endwhile;
     Q7 ]& n( B& D6 m
7.         endif;
   $ s7 Y7 P+ n, ^/ s9 E' }
8.         wp_reset_query();
   
9.         return $return_string;
   0 j! a, \% e, `! c
10. }

複製代碼

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


1.2 註册短代碼
  A$ D! f% x$ R) _9 l現在，我們告訴Wordpress這個函數是一個短代碼：

1. function register_shortcodes(){
   
2.         add_shortcode('recent-posts', 'recent_posts_function');
   ) P( W* q) x- T  @& `  w7 J9 m0 Q
3. }

複製代碼

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

1. [recent-posts]

複製代碼

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

0 i2 [$ X7 i1 `( p6 n
% B: y+ M. c/ Z4 B& h1.3 Hook into WordPress
- V& G5 I+ [1 r% l: D. x, D0 d
為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。

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

複製代碼

* d. E! a7 O$ k* q) O5 v- ]7 _0 i1.4 測試短代碼
簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :

1. [recent-posts]

複製代碼

2. 進階短代碼

2.1 短代碼参數

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

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

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

1. function recent_posts_function($atts){
   
2.         extract(shortcode_atts(array(
   " A/ w9 [) d$ Y- U7 N- `  R
3.                 'posts' => 1,
   
4.         ), $atts));
   5 j* u) Q4 ?; b9 g, X7 K
5. 
   5 H0 \" h2 v* I( V
6.         $return_string = '<ul>';
   
7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
8.         if (have_posts()) :
   
9.                 while (have_posts()) : the_post();
   3 b# z0 {. K) ]2 |
10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    * k/ S$ m% K; t+ N! R
11.                 endwhile;
    " L0 v" Y9 H/ X) c
12.         endif;
    : f3 P4 n/ \0 g4 C
13.         $return_string .= '</ul>';
    8 I- Y+ Y0 a8 _9 n1 c  i, a# i% ?
14. 
    
15.         wp_reset_query();
    
16.         return $return_string;
    9 }- b3 i/ j! w
17. }

複製代碼

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

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

複製代碼

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

  g- _6 z7 n7 @7 v9 H( M. \2.2 短代碼中增加内容

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

1. function recent_posts_function($atts, $content = null) {
   6 o1 A7 D% O8 D& e
2.         extract(shortcode_atts(array(
   
3.                 'posts' => 1,
   
4.         ), $atts));
   
5. 
   * o! N+ G$ Z" M8 Q
6.         $return_string = '<h3>'.$content.'</h3>';
   ) i8 ~/ o! u- u- N
7.         $return_string .= '<ul>';
   
8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
   
9.         if (have_posts()) :
   ) r% r0 U6 d5 R5 G! B
10.                 while (have_posts()) : the_post();
    " g3 Z' j7 Z0 A3 a% k- @
11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    ' o# K) Z6 B! g+ D4 \
12.                 endwhile;
    
13.         endif;
    ; _4 ^# d7 w5 ?2 J1 l- H& E+ m* m( o7 z
14.         $return_string .= '</ul>';
    " m. u) F: c2 L# s+ S- }; l/ ?
15. 
    
16.         wp_reset_query();
    ; j' h( p( t3 D) q6 |) j+ M4 I
17.         return $return_string;
    
18. }

複製代碼

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

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

複製代碼

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

' v1 G# X4 r: Z8 V& z, w

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

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

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

! N& \' G* K6 k0 Q. Y3 E+ P

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

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

複製代碼

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

9 c+ R. @+ v, t/ W. T" P9 S- `; Y

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

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

複製代碼

在摘要中啟用短代碼：

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

複製代碼

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

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

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

4.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', {
   ; c, c+ G- m5 L9 X5 F
3.                 init : function(ed, url) {
   - k5 f- |5 F0 X0 n: V! {
4.                         ed.addButton('recentposts', {
   
5.                                 title : 'Recent posts',
   
6.                                 image : url+'/recentpostsbutton.png',
   
7.                                 onclick : function() {
   
8.                                         var posts = prompt("文章數量", "1");
   / t3 g* ?4 d& D8 F2 m* k& K8 [, U
9.                                         var text = prompt("請填入列表標題", "最新文章");
   8 H, D0 }, Z# G# E1 x& v
10. 
    
11.                                         if (text != null && text != ''){
    
12.                                                 if (posts != null && posts != '')
    - d8 @0 Y% W2 O) s/ O: a
13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    , S8 g* `! n& L( @) y5 T
14.                                         else
    
15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    2 \  b$ M+ d( H% X
16.                                         }
    
17.                                         else{
    & U2 b/ V/ `: ^) A- T# {
18.                                                 if (posts != null && posts != '')
    # g( ?3 f7 M% H& n, f& g
19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    8 l* s/ O/ a! E. J  w# E9 S
20.                                                 else
    . A0 |$ K( w% S6 E5 u  n, k
21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    
22.                                         }
    ' S0 e) o1 Q: Z: X5 s# f  s: P( J
23.                                 }
    . |$ m4 W7 F0 g; r, j' @' c* ^
24.                         });
    , I. x# l0 h  Y' V
25.                 },
    
26.                 createControl : function(n, cm) {
    + {% Q  w0 J7 b$ o1 L4 r
27.                         return null;
    " x3 D  F4 j3 c' s6 |, C& w
28.                 },
    3 y) Y& K, C1 m, c
29.                 getInfo : function() {
    . j  ]- D7 \- J5 e# Y
30.                         return {
    
31.                                 longname : "Recent Posts",
    9 n0 x" z! h5 F3 R+ t
32.                                 author : 'Specs',
    . f$ u& V- y6 d4 @
33.                                 authorurl : 'http://9iphp.com',
    8 A; a. c! x5 ]5 G  x! G6 `1 @3 h' V
34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    
35.                                 version : "1.0"
    
36.                         };
    0 d8 H8 H  _5 @" i2 q3 R
37.                 }
    6 S1 V: ~: L" |  ^% v. b
38.         });
    
39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    7 T; Y8 q1 S1 `! q+ J8 U" J/ K
40. })();

複製代碼

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

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

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

- T& }9 X9 {$ n+ Q  k

4.2 註冊按鈕及TinyMCE插件

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

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

1. function register_button( $buttons ) {
     U- B# ~0 M/ w3 u
2.         array_push( $buttons, "|", "recentposts" );
   
3.         return $buttons;
   0 K/ M* Q0 ^, s' ], ^: k
4. }

複製代碼

第二個函數 add_plugin() 指定JS文件的路徑及文件名。
  N5 x. g4 j% w/ P- S

1. function add_plugin( $plugin_array ) {
   ! k: b: x  _' ?4 S) y0 M, ^
2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
   
3.         return $plugin_array;
   ) A1 t1 U& t$ w! \. p
4. }

複製代碼

下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。
6 `& P% _$ e9 |# x* V1 `' J

1. function my_recent_posts_button() {
   5 s; J9 |4 N. H, t
2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
   ; m) f* p. ^# H) Z2 {- K+ J" A6 T+ u6 I
3.                 return;
   , l' G+ y+ I; V& S$ |
4.         }
   
5. 
   
6.         if ( get_user_option('rich_editing') == 'true' ) {
   3 c1 Y( G' ?+ E/ J$ ?$ o7 d
7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
   
8.                 add_filter( 'mce_buttons', 'register_button' );
   - I$ j- R3 Y" w" ^
9.         }
   : d8 E; u2 q/ S7 z
10. }

複製代碼

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

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

複製代碼

3 o7 k# N- O2 ~+ e- ^1 V, n& _4.3 按鈕的用法

8 ?# ]! u8 R( r! _3 u1 _" s5 V

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

' P0 [' e- w0 F* T9 ]# K

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

1 {+ m- ?) z0 f7 S$ A5 O

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

" z4 b7 D& L- l# o  ]( f$ Z

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

& K5 a( T4 r6 G% m" w& |

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

參考文章: 1 2

---

歡迎光臨 52AV手機A片王|52AV.ONE (https://www.itech.casa/)

Powered by Discuz! X3.2