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

標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕 [打印本頁]
作者: IT_man    時間: 2016-6-9 12:40
標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕
WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)& E  D2 z/ q8 r9 u% n

: b0 J3 R' T1 q7 f# q2 k& q  fwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
8 b+ k; Q) I& \3 v" e以下是 wordpress 短代碼的詳细介紹及進階應用。1 i& n0 V( G2 x
5 }4 Y, c8 @+ |
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
/ b: b( S4 y; M6 v# z! }" f
  1. [recent-posts]
複製代碼
此外 , 我們可以設定一個參數來控制文章的數量 :3 L8 d* b' U: o; s' I
  1. [recent-posts posts="5"]
複製代碼
此外 , 我們也可以為文章列表新增一個標題 :
# u$ ^8 Y5 }2 ?9 X6 n, ?
  1. [recent-posts posts="5"]Posts Heading[/recent-posts]
複製代碼

1 T* a; c* M" K" V5 ^: z6 Z0 h6 @( x- G8 x$ O1 j+ P# r
1. 簡單的短代碼1 S& k  J1 |. V% a* P: J. `
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
8 J% q! l" ^7 c9 \( q+ B
  1. [recent-posts]
複製代碼
該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :0 P  W9 q% l+ Y. b. k; P+ `

+ a. e, D! J7 v& V$ l本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
# W9 j/ }% |' x0 x5 A. M$ y+ }5 B1.1 建立返回函數) B9 t0 d/ @5 ^- H. ?/ u0 m
當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
/ X. k6 D3 n( e' G8 n; b  b& j
  1. function recent_posts_function() {
    , V* y+ j0 l2 E
  2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));4 x: I/ B5 `6 r' t/ u9 m' B  v3 N
  3.         if (have_posts()) :
    2 t# C8 Z( S% k. D- \* X! q6 Z
  4.                 while (have_posts()) : the_post();
    ) d$ t$ R' L5 l+ L9 X
  5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
    & a. E: U. ^' ], v# D
  6.                 endwhile;) S( F; b% P  Q) R  h
  7.         endif;
    6 w  ~2 R0 e. x' Q# T
  8.         wp_reset_query();6 C- Y+ v8 k: h$ C( N* B
  9.         return $return_string;/ _2 S+ P) }8 `4 _- R& a
  10. }
複製代碼
如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
  m, z7 t5 z! |# G) t7 u
& m) V! \; x$ d% b) h
; A. v; ?, m1 g1 S/ A- A1.2 註册短代碼& N. C5 e1 m( `
現在，我們告訴Wordpress這個函數是一個短代碼：
  1. function register_shortcodes(){& L9 i4 o; m3 l% F+ Q
  2.         add_shortcode('recent-posts', 'recent_posts_function');9 T5 w$ t4 W# F( [$ i" k2 z
  3. }
複製代碼
當在文章的內容中使用短代碼
6 H- \9 S) T& A* b1 V
  1. [recent-posts]
複製代碼
將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。( V0 v6 v2 K6 n% ]

5 V* X+ Z( ?+ f5 j0 a; K+ T: b! ~/ t! S$ g3 f" [
1.3 Hook into WordPress0 I* I* y5 K, _1 I0 r; a4 P  t

, ^" ^2 f( I0 G, K/ `; m9 b  V為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。% H4 x( B) t: J" Q* S0 N
  1. add_action( 'init', 'register_shortcodes');
複製代碼
' I# z( D7 }+ z! Y8 K: M
1.4 測試短代碼) t) K/ a, n+ x, e: z% I& `! f
簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :
  1. [recent-posts]
複製代碼
2. 進階短代碼
2.1 短代碼参數
短代碼是非常有彈性 , 因為它讓我們加入參數可讓它們有更多的功能。 假設我們必須要顯示某一特定數量的最新的文章。 為了達到這個目的 , 我們需要給短代碼指定其他選項以顯示最近的文章數。
我們需要使用兩個函數 ,第一個是內建在 wordpress 的shortcode _ atts ( ) 函式 , 它把用戶的短代碼屬性與本地屬性結合在一起 , 並填入到想要的位置。 第二個是 PHP的extract() 函数 , 顧名思義 , 它萃取出短代碼中的各個屬性。
展開我們的返回功能 , 我們新增一個參數 $atts, 它是一個陣列,從中可以提取到我們需要的文章數。 我們查詢資料庫來取得指定數目的文章 , 並傳回一個列表 :
  1. function recent_posts_function($atts){
    6 c% C6 k% p7 U+ e8 m+ L
  2.         extract(shortcode_atts(array(
    . U. E7 _3 n& U: g& I. w6 ]
  3.                 'posts' => 1,
    / z) |  O, w' M/ L& D( |% I
  4.         ), $atts));: W1 z/ v9 r' D4 S7 v
  5. ! R/ ~0 Q! z' H3 R3 t& _
  6.         $return_string = '<ul>';$ b7 }: l7 u6 t) B3 l
  7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));/ U- J8 J0 V$ ^+ H1 A, t$ \" \
  8.         if (have_posts()) :8 @4 \) S7 j5 v  L. f- L  H" j
  9.                 while (have_posts()) : the_post();
    & }! k) F4 l& S: M& w6 F
  10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    % r" A* l: w# m. n- Z( h, c
  11.                 endwhile;7 l! C' E4 g7 ]: K$ ]
  12.         endif;- O' A7 e" k4 K% u' v& `9 D: L2 b
  13.         $return_string .= '</ul>';, B0 ?( l5 f: h8 M7 y0 [

  14. 1 s/ r7 o6 D! n: `3 G
  15.         wp_reset_query();
    2 F5 i/ S# J# V, p% ~
  16.         return $return_string;, T% g5 ]/ D) k8 \! c; b
  17. }
複製代碼
如果使用者未指定此選項 , 1 將是預設值。 我們可以加入多個屬性使短代碼接受更多的參數。 使用這項強化函數 , 我們就可以指定調用最新文章的數量 :
  1. [recent-posts posts="5"]
複製代碼
當顯示於瀏覽器 , 您就可以看到最近的五篇文章列表
* b$ R( F/ Z2 C! Q: R; v2 P3 X
2.2 短代碼中增加内容
我們可以繼續擴展我們的短代碼、新增一些內容作為參數 來傳遞, 例如"最新文章列表的標題"。 若要達成此目的 , 我們需要在返回函數中新增第二個參數$content , 並把它顯示在列表前面的一個 <h3> 標簽中。新的函數如下：
  1. function recent_posts_function($atts, $content = null) {
    - S  O8 a, M* ?4 B; r
  2.         extract(shortcode_atts(array(
    6 @. i- p! v2 x4 l
  3.                 'posts' => 1,# n% p$ {8 Z3 K. M* o) F2 K' J0 B
  4.         ), $atts));1 ]8 b% P0 w, |( f

  5. $ Y% V! w' [+ V6 `# ~- Q
  6.         $return_string = '<h3>'.$content.'</h3>';% I( K1 U9 b) k2 V8 c$ n
  7.         $return_string .= '<ul>';3 ~8 \; s' y! F1 R
  8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));5 a. x! Z5 a7 j  X* j
  9.         if (have_posts()) :
    & K2 W, V4 L' ?6 X0 G
  10.                 while (have_posts()) : the_post();7 c% K7 y6 O6 A' y
  11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    9 |+ }0 Z2 U$ I$ A2 z- i) m9 o
  12.                 endwhile;
    - @" j$ b' w% F9 U* Q& g& e- d
  13.         endif;
    / ^0 v4 N3 @' @$ z* {; [
  14.         $return_string .= '</ul>';5 O* p0 {; Z- l* ^$ E  C9 F' @
  15. % t+ c( U9 }) k# q! G
  16.         wp_reset_query();5 p- l" g& z9 `
  17.         return $return_string;0 I  Y7 M. t" }4 J9 Y! M! X
  18. }
複製代碼
這種短代碼類似於一個HTML標簽：
  1. [recent-posts posts="5"]This is the list heading[/recent-posts]
複製代碼
除了文章列表多了一個標題，其餘的內容和上一個示例是一樣的：
1 m3 j+ S9 N- ~: ?6 @( g
3. 在任何地方顯示短代碼
3.1 在側邊攔小工具中使用短代碼
預設情況下 , 側邊欄小工具是忽略短代碼的，您可以將此程式碼放在小工具

5 _5 |# s4 B; O1 Z  H% I8 M
我們可以採用一行程式碼來啟用這個函數 , 為了使側邊欄小工具支援短代碼 , 新增以下的程式碼 :
  1. add_filter('widget_text', 'do_shortcode');
複製代碼
現在不需要修改任何其他地方 , 刷新頁面, 側邊欄將會正確地顯示

2 {: ^7 g, ]4 }) w* c- c
同樣的，在評論中啟用短代碼：
  1. add_filter( 'comment_text', 'do_shortcode' );
複製代碼
在摘要中啟用短代碼：
  1. add_filter( 'the_excerpt', 'do_shortcode');
複製代碼
4. TinyMCE編輯器增加短代碼按鈕# N) k* W1 ?3 j. u

: E: y/ ^- C* B雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。
要解決這個，我們可以給 TinyMCE編輯器增加一個按鈕，使用戶可以透過簡單的點擊來增加短代碼。建立這個按鈕僅需兩個步驟：
4 p  }! }9 W$ G
4.1 透過JS文件來建立按鈕
JS文件是透過 TinyMCE API 來註冊 TinyMCE 插件的。我們在主題的 js 目錄下(/wp-content/themes/你主題名稱/js/)建立 recent-posts.js ，並貼進去下面的代碼（需要把按鈕圖片檔(/wp-content/themes/你主題名稱/js/recentpostsbutton.png)也放在同一個目錄）：
  1. (function() {6 a' J  f' K+ R1 |- k
  2.         tinymce.create('tinymce.plugins.recentposts', {, ]/ m" D& C7 z/ z
  3.                 init : function(ed, url) {( b; n( K1 M, e
  4.                         ed.addButton('recentposts', {. W- r( U2 g/ u' u3 o. c/ {
  5.                                 title : 'Recent posts',9 i# S2 Y% `" U0 a' [" H6 `
  6.                                 image : url+'/recentpostsbutton.png',, _) A3 H6 N9 w( h7 q& i6 D1 `9 K
  7.                                 onclick : function() {! w# l2 H% V: i1 [7 Q2 Z# Z9 `; i! i
  8.                                         var posts = prompt("文章數量", "1");) A$ l6 Z6 n% c  Q
  9.                                         var text = prompt("請填入列表標題", "最新文章");) Z& C, K5 \0 O! q$ K

  10. ' r: e, z& W; `1 v, n4 A% z- `
  11.                                         if (text != null && text != ''){5 N; s3 f9 G6 c1 T/ A; `
  12.                                                 if (posts != null && posts != '')& `) D' W" c0 m! k1 I8 @: \7 w
  13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');1 [9 R2 n+ }5 R  i4 Z. ]6 O
  14.                                         else( v- b3 ]. b# O6 F9 \! e$ m% g! z
  15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');8 f( X5 p3 H7 l2 u0 t) ]% a
  16.                                         }& N7 o, ]- |; q  |: o2 q
  17.                                         else{1 Z5 g/ c* u, `8 ?# Q
  18.                                                 if (posts != null && posts != '')4 I: x9 V! N' T: ]0 E
  19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');# W% j! Y  B0 f0 j6 _7 Z2 r
  20.                                                 else
    ! c! b7 V, ]- x
  21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    : I: x9 t+ ^: t# q2 y/ k5 b$ x& b
  22.                                         }
    2 N- `6 V: u, s1 z+ n
  23.                                 }) n! A" y8 y. B9 ~- c4 u" r3 W8 a
  24.                         });
    7 Y# R% t) h: _
  25.                 },! r% w6 h8 ?" o- l' L
  26.                 createControl : function(n, cm) {* L/ G( {4 }: ^5 o5 ?
  27.                         return null;
    1 d: E, x7 k4 t0 u
  28.                 },
    * A- N# V6 X5 \) C$ V& l
  29.                 getInfo : function() {
    % X/ K2 I# r, d7 X8 l/ U
  30.                         return {; B: n- ]* d/ w1 [' {$ Z
  31.                                 longname : "Recent Posts",
    8 T+ M3 `0 I- D
  32.                                 author : 'Specs',$ i  ~4 o/ s: J! \" b
  33.                                 authorurl : 'http://9iphp.com',
    3 Y# u5 A; w7 Z  _: H& R3 _
  34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',3 i3 J5 `: ]! h0 O/ h! C$ Z9 H
  35.                                 version : "1.0"
    0 m# P2 M; n6 C* ]0 `( ?* u: C
  36.                         };
    1 G& ?1 i* T% x0 c) B
  37.                 }7 l8 ]6 B( ~( P2 c7 J" q$ @
  38.         });
    3 Q0 ~! w* i; _" h3 X
  39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);. ^5 c3 u$ H( T# A: M/ l4 Q& ]; X) I
  40. })();
複製代碼
我們透過呼叫 tinymce.create() 建立了一個插件。代碼中最重要的是 init() 函數，我們定義了一個名字，一個icon文件及 onclick() 事件處理程序。
在 onclick() 函數的前兩行，依序彈出兩個對話框讓用戶輸入文章數量及列表標題兩個參數，然後根據用戶輸入，把短代碼插入到編輯器中。
最後，TinyMCE插件透過 add() 函數增加到 PluginManager。現在我們已經成功的整合了 [recent-posts] 短代碼到Wordpress中。

. ]- z1 `6 ?; F- E6 \, X
4.2 註冊按鈕及TinyMCE插件$ j' ?- l5 l/ r: T9 n

& k7 u( z; |! o' R/ F
當您完成建立的JS 檔 , 我們現在需要註冊它和短代碼按鈕。 因此我們建立了兩個函數並把它們繫結至適當的 wordpress 過濾器中。
第一個叫做 register_button() 的函數把短代碼增加到按鈕陣列中，在現有按鈕和新按鈕之間增加分割線。
  1. function register_button( $buttons ) {
    + H% k5 d6 W0 J# ]9 N; ~; }, Z
  2.         array_push( $buttons, "|", "recentposts" );) o! K" {. S9 f6 k  S! d) o
  3.         return $buttons;5 U  V6 s, L" Y  v5 }- m; m
  4. }
複製代碼
第二個函數 add_plugin() 指定JS文件的路徑及文件名。! s# P) ?$ ^" |0 d: G( K. N- t
  1. function add_plugin( $plugin_array ) {" g6 b1 O8 V. p" B0 V& O
  2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';" J7 e' v0 X$ a) q6 s; G0 A$ n
  3.         return $plugin_array;. D2 j, R3 C7 j: \# w, T$ Z
  4. }
複製代碼
下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。$ ~( ?. S- n5 y; N* t" E. t- R
  1. function my_recent_posts_button() { 8 k  j. Q6 i) A: N7 G8 T- W0 U
  2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {1 }! ^8 p6 |4 K$ ^4 m
  3.                 return;% H- v2 M4 b7 f/ Z9 V& C! p
  4.         }+ d5 L& ^4 D5 B3 x) S

  5. 9 \) o6 b: C: _# \( q
  6.         if ( get_user_option('rich_editing') == 'true' ) {3 U! \3 S. j5 u9 N
  7.                 add_filter( 'mce_external_plugins', 'add_plugin' );& I" F. q! N7 Q  P/ E' j! z
  8.                 add_filter( 'mce_buttons', 'register_button' );
    $ V* N& ?2 Q9 N  p  _
  9.         } 1 ~+ ?" c6 b1 |; Q% w
  10. }
複製代碼
當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。: [8 H9 q7 T" u! _7 |) ~, `' k
最後把函數勾到Wordpress初始化函數
  1. add_action('init', 'my_recent_posts_button');
複製代碼
* Q" S& p5 o$ k- i( D/ L9 u
4.3 按鈕的用法

- |1 @% |: h. M( K6 b: D! ?& l
為了測試程式碼是否正確，我們打開一篇新的文章，這時一個我們剛剛定義的按鈕是不是已經出現在第一行的末尾了？如下圖所示：
$ P' O& U8 G) g. e, S4 v
點擊按鈕的時候，會彈出對話框讓我們輸入文章的數量：

' x+ S+ p; [/ D) c) |3 P0 G6 L# s% @
輸入完點擊確定後，會彈出第二個對話框，讓我們輸入列表的標題：

/ e7 n# W9 K6 S" e) Z
參數留空的話，不會出現在最後的代碼中。最後，短代碼會新加到編輯器中：
( }% _; v6 I" b+ g+ U
到此就大功告成了。想要增加其他功能的短代碼及按鈕可以參考上面的教學，如法炮製舉一反三，相信可以製作出符合各位需求的短代碼功能。
參考文章: 1 2




歡迎光臨 52AV手機A片王|52AV.ONE (https://www.itech.casa/) Powered by Discuz! X3.2