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

標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕 [打印本頁]
作者: IT_man    時間: 2016-6-9 12:40
標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕
WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)* o2 q+ n! `) ]

3 V, F# _  M& D4 e0 Ywordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
) l# h3 C3 u( D, f5 b+ y# }5 w/ f以下是 wordpress 短代碼的詳细介紹及進階應用。
& M5 c& X! F4 Z+ J! u1 |" B- T: y/ [/ A  x& N; i7 L# b# N+ b6 @
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
/ @( r$ o* w2 c% {) P
  1. [recent-posts]
複製代碼
此外 , 我們可以設定一個參數來控制文章的數量 :0 j: `+ c$ J7 R1 M/ R) |& e
  1. [recent-posts posts="5"]
複製代碼
此外 , 我們也可以為文章列表新增一個標題 :+ P9 a. u3 J- v; s/ `
  1. [recent-posts posts="5"]Posts Heading[/recent-posts]
複製代碼

6 H% r7 Y9 |/ z1 q
3 V% ?/ s8 c' e9 k1. 簡單的短代碼% m) Z1 F9 q- s7 V
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :+ L4 j; u# c* y! Z# Z3 k+ ]
  1. [recent-posts]
複製代碼
該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
* \: P7 z7 ~9 r1 g5 Z) m5 a' z7 [+ J( \$ v  {, I1 Z& [
本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。5 _$ j6 I6 u+ \
1.1 建立返回函數0 I7 ~- q% I, X0 ^& f
當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。) h! I5 F+ P) z( i4 S0 T* M
  1. function recent_posts_function() {
    + ?4 e' x+ |& A1 E
  2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
    . R* L$ H, u) \; p: b
  3.         if (have_posts()) :( U  C4 @7 d4 M1 A* _# i6 Z: W& k
  4.                 while (have_posts()) : the_post();
    * ]+ k, r9 M8 X1 R& M+ \* B7 f! e
  5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';# W/ r4 ]; j# Q$ t) p5 x4 D8 x2 H9 _5 p
  6.                 endwhile;* O: p9 W# m' Q- A/ n
  7.         endif;# g2 V) P: w8 H1 B: Q" i" ]' T
  8.         wp_reset_query();
    . D. k) P8 m( [1 r3 H% D9 j
  9.         return $return_string;
    / @/ x1 L0 ?# r1 P' z3 w) Q8 q
  10. }
複製代碼
如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。5 r) j' w0 n; k
6 @6 }8 t& ]( d, |9 C" \/ m

! B" h! F; [8 R% L1.2 註册短代碼
1 e3 d* n3 @( c; N現在，我們告訴Wordpress這個函數是一個短代碼：
  1. function register_shortcodes(){6 G1 V, i5 [+ ~1 H
  2.         add_shortcode('recent-posts', 'recent_posts_function');
    ! a  `/ n, l3 B( q$ D
  3. }
複製代碼
當在文章的內容中使用短代碼+ n/ j. H0 |; O; J
  1. [recent-posts]
複製代碼
將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。
7 @( T  {4 F- M& z7 @. N3 j, R' H" n. r0 z7 y' W) f3 e4 |

0 [/ k/ o- _5 o% E: @1.3 Hook into WordPress
( ~& D3 p) r: j& N+ i, R* [' d
$ z1 a% }/ x7 v6 Q0 E2 r, S" a為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
& R3 x% x- E0 a& q7 ?/ y$ l
  1. add_action( 'init', 'register_shortcodes');
複製代碼

% R# B; _) g) k+ i( O- q* R, G) P9 V1.4 測試短代碼+ v, n- [1 A/ z/ h
簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :
  1. [recent-posts]
複製代碼
2. 進階短代碼
2.1 短代碼参數
短代碼是非常有彈性 , 因為它讓我們加入參數可讓它們有更多的功能。 假設我們必須要顯示某一特定數量的最新的文章。 為了達到這個目的 , 我們需要給短代碼指定其他選項以顯示最近的文章數。
我們需要使用兩個函數 ,第一個是內建在 wordpress 的shortcode _ atts ( ) 函式 , 它把用戶的短代碼屬性與本地屬性結合在一起 , 並填入到想要的位置。 第二個是 PHP的extract() 函数 , 顧名思義 , 它萃取出短代碼中的各個屬性。
展開我們的返回功能 , 我們新增一個參數 $atts, 它是一個陣列,從中可以提取到我們需要的文章數。 我們查詢資料庫來取得指定數目的文章 , 並傳回一個列表 :
  1. function recent_posts_function($atts){  `& H% I& g/ b; j1 x7 r
  2.         extract(shortcode_atts(array(% d5 g: X$ L+ `  c7 T) r
  3.                 'posts' => 1,
    2 e0 W6 N( H  j8 n- B5 H, o# ?
  4.         ), $atts));5 p; M( l9 B4 ?9 c& _! b+ d

  5. / s1 D4 b* O9 |$ A
  6.         $return_string = '<ul>';
    + q% D/ u7 h/ k4 e- M* Z0 X; e
  7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
    " V& v( s4 d* U6 O  Y! V
  8.         if (have_posts()) :+ A& n6 W% l" ?# C: I! M1 ^5 n
  9.                 while (have_posts()) : the_post();
    , a" `2 k/ n/ L4 r# j% v
  10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    " k7 t& M; w0 g  |; l3 v
  11.                 endwhile;
    # J5 u) e& e, {, B. f4 Y3 Q' d
  12.         endif;, d3 A2 I, x. `. E
  13.         $return_string .= '</ul>';
    6 L) V, {  A  i  T& D) ~5 }/ o

  14. 5 Y+ B, m; r# k* z) a, n9 ?) ]
  15.         wp_reset_query();  R6 x  V5 d# |, J, ~$ e) T
  16.         return $return_string;- a% g, `- @  t5 M5 G' G) q; f
  17. }
複製代碼
如果使用者未指定此選項 , 1 將是預設值。 我們可以加入多個屬性使短代碼接受更多的參數。 使用這項強化函數 , 我們就可以指定調用最新文章的數量 :
  1. [recent-posts posts="5"]
複製代碼
當顯示於瀏覽器 , 您就可以看到最近的五篇文章列表

2 d' B$ j- b8 m/ e' n7 }2.2 短代碼中增加内容
我們可以繼續擴展我們的短代碼、新增一些內容作為參數 來傳遞, 例如"最新文章列表的標題"。 若要達成此目的 , 我們需要在返回函數中新增第二個參數$content , 並把它顯示在列表前面的一個 <h3> 標簽中。新的函數如下：
  1. function recent_posts_function($atts, $content = null) {
    9 P0 s* }1 ?2 B+ N
  2.         extract(shortcode_atts(array(; ^# e6 k% F) y8 s6 ~1 p
  3.                 'posts' => 1,
    + D6 F3 r& g2 L3 L$ @$ p
  4.         ), $atts));* T- W9 f+ Y( Y0 u3 V! c" K

  5. 3 f8 H( f6 G. L
  6.         $return_string = '<h3>'.$content.'</h3>';
    ' Q) x: Y/ y8 q* H4 P2 }
  7.         $return_string .= '<ul>';8 h$ g. X, W1 l! R
  8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
    - Y3 v+ a$ R; }) d1 _# X; i
  9.         if (have_posts()) :
    - \, S) a* O& g* I, I9 s
  10.                 while (have_posts()) : the_post();# [! s, T2 }, F
  11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';; I# b- R+ ]4 i; u4 r, Y
  12.                 endwhile;7 c7 h, b: f) o; I
  13.         endif;
    5 c, V5 [% z# M3 P: N1 ^% G& s6 G! Z' p
  14.         $return_string .= '</ul>';4 P$ y) k! {3 ~/ m! k' |

  15. ) }6 U9 g: s1 n9 t
  16.         wp_reset_query();6 c$ v" \, B+ d9 S$ q# o+ Q! m
  17.         return $return_string;7 j8 u3 Q( \5 D: ?! j3 c5 S# z8 ~" v
  18. }
複製代碼
這種短代碼類似於一個HTML標簽：
  1. [recent-posts posts="5"]This is the list heading[/recent-posts]
複製代碼
除了文章列表多了一個標題，其餘的內容和上一個示例是一樣的：

6 |/ v2 o8 p; }7 H) [# s
3. 在任何地方顯示短代碼
3.1 在側邊攔小工具中使用短代碼
預設情況下 , 側邊欄小工具是忽略短代碼的，您可以將此程式碼放在小工具
' T% U7 F/ L) F
我們可以採用一行程式碼來啟用這個函數 , 為了使側邊欄小工具支援短代碼 , 新增以下的程式碼 :
  1. add_filter('widget_text', 'do_shortcode');
複製代碼
現在不需要修改任何其他地方 , 刷新頁面, 側邊欄將會正確地顯示
' R9 I3 a. o5 B3 w4 P  |  g
同樣的，在評論中啟用短代碼：
  1. add_filter( 'comment_text', 'do_shortcode' );
複製代碼
在摘要中啟用短代碼：
  1. add_filter( 'the_excerpt', 'do_shortcode');
複製代碼
4. TinyMCE編輯器增加短代碼按鈕
6 |7 r$ b. \/ }9 U' s* Z* @; i5 B  w7 ?) r% f8 z+ V$ T6 S( N
雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。
要解決這個，我們可以給 TinyMCE編輯器增加一個按鈕，使用戶可以透過簡單的點擊來增加短代碼。建立這個按鈕僅需兩個步驟：

3 ^2 r% ~/ C/ O" z% e4.1 透過JS文件來建立按鈕
JS文件是透過 TinyMCE API 來註冊 TinyMCE 插件的。我們在主題的 js 目錄下(/wp-content/themes/你主題名稱/js/)建立 recent-posts.js ，並貼進去下面的代碼（需要把按鈕圖片檔(/wp-content/themes/你主題名稱/js/recentpostsbutton.png)也放在同一個目錄）：
  1. (function() {+ Z; E/ t! Y6 G  o! f
  2.         tinymce.create('tinymce.plugins.recentposts', {+ J" c) _' L0 ^, V$ U/ g4 V6 C
  3.                 init : function(ed, url) {1 m) j4 F: a. W5 E5 |9 q
  4.                         ed.addButton('recentposts', {! b( n6 I) ?, S% a* f
  5.                                 title : 'Recent posts',
    8 k2 v0 {7 t9 \9 S' |
  6.                                 image : url+'/recentpostsbutton.png',! P: O. d- c2 N. U, q3 L4 E" z
  7.                                 onclick : function() {) R$ r" _  p6 {; c
  8.                                         var posts = prompt("文章數量", "1");
    & `0 p, Q) b7 S5 {/ C( c3 j
  9.                                         var text = prompt("請填入列表標題", "最新文章");
    ! t/ @0 [3 T0 o

  10. ) H3 ?2 n7 X+ r2 p& h) ]& g
  11.                                         if (text != null && text != ''){0 r0 f  L: w! |- v7 G4 g/ q
  12.                                                 if (posts != null && posts != '')3 b* P& k( G7 T% g% h
  13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');0 i0 w! @, Z9 {! {1 W/ s- s
  14.                                         else
      }5 e% z  n2 _  _! L: X" A
  15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');0 t* V3 M+ \8 n
  16.                                         }, J- G8 z8 H# |+ c' x) a4 D& ~
  17.                                         else{
    7 N( h, S8 a- y6 p
  18.                                                 if (posts != null && posts != ''); f  J1 C' n4 m+ G" X5 Q. a
  19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    * N% l2 H; P; N7 w
  20.                                                 else! k; Q" W# ]+ D: d* e$ o* t
  21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');, @, L! o8 J( }7 c# `4 @0 w1 H
  22.                                         }
    - @3 |0 r+ o9 |/ L$ l( C% i8 N
  23.                                 }
    ' z6 x2 s% e6 {0 X' L9 V! g
  24.                         });$ U! R: l7 Q) o0 O
  25.                 },
    ' ?/ h' u0 m! X
  26.                 createControl : function(n, cm) {
    - b: C1 w6 l7 O9 q9 R. M
  27.                         return null;9 Q) w/ |' a/ X% g1 Y
  28.                 },8 r5 D; T7 A! j( `5 Z
  29.                 getInfo : function() {0 [" V) g7 l+ K- d9 G% H% Z& E
  30.                         return {9 Y/ A* i7 Z2 _; L8 C0 q
  31.                                 longname : "Recent Posts",  d$ P8 S6 J) U$ }
  32.                                 author : 'Specs',
    4 \" g# k( w. t+ F1 w' m
  33.                                 authorurl : 'http://9iphp.com',
    0 j4 o0 m* w" Y# L0 G1 l$ c$ C
  34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    $ o+ I8 ]( n+ n3 C( y
  35.                                 version : "1.0"6 ^2 E) @1 q3 a) _
  36.                         };1 P) h! N( V: L6 y& I& F
  37.                 }2 S" z: A& o  _# R  E
  38.         });
    0 j4 n' O& a: u5 K
  39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);$ H$ c1 ~5 k, r0 t$ }3 H
  40. })();
複製代碼
我們透過呼叫 tinymce.create() 建立了一個插件。代碼中最重要的是 init() 函數，我們定義了一個名字，一個icon文件及 onclick() 事件處理程序。
在 onclick() 函數的前兩行，依序彈出兩個對話框讓用戶輸入文章數量及列表標題兩個參數，然後根據用戶輸入，把短代碼插入到編輯器中。
最後，TinyMCE插件透過 add() 函數增加到 PluginManager。現在我們已經成功的整合了 [recent-posts] 短代碼到Wordpress中。

' Y: W* I1 W, `+ _2 L
4.2 註冊按鈕及TinyMCE插件/ {, {" ~& ]) j$ V, O" [& P4 C
5 m) y" s& G6 L" r
當您完成建立的JS 檔 , 我們現在需要註冊它和短代碼按鈕。 因此我們建立了兩個函數並把它們繫結至適當的 wordpress 過濾器中。
第一個叫做 register_button() 的函數把短代碼增加到按鈕陣列中，在現有按鈕和新按鈕之間增加分割線。
  1. function register_button( $buttons ) {. y4 t, J( x' @/ m) r1 D- e
  2.         array_push( $buttons, "|", "recentposts" );/ \; N; J+ T& U7 B
  3.         return $buttons;
    % T* q( m8 ~# W3 {5 U
  4. }
複製代碼
第二個函數 add_plugin() 指定JS文件的路徑及文件名。. j/ D2 I. M9 W' \& O6 K
  1. function add_plugin( $plugin_array ) {
    2 q2 j9 L; \" |- L
  2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
    ( |6 }& a% i: ]9 R
  3.         return $plugin_array;, t" X% Q' F; Q4 V+ J; r, B
  4. }
複製代碼
下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。
7 X8 W* j. f+ E
  1. function my_recent_posts_button() {
    1 ?' A* j7 J1 z$ w* a) b2 n6 z
  2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
    7 H) U  x' F8 N1 U0 F& x
  3.                 return;6 ~: O5 {8 `. O& R
  4.         }. y3 E. e- w) W8 Z4 \2 M
  5. 9 @& |4 E" J9 f  _
  6.         if ( get_user_option('rich_editing') == 'true' ) {7 k5 E- x8 J3 ~; e6 R  X
  7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
    $ j8 R  N* [4 K* Q
  8.                 add_filter( 'mce_buttons', 'register_button' );
    % m  w8 {% u( P. s6 u2 h9 d# e
  9.         }
    1 m' _! N6 `' \) X/ x9 s& J7 g9 P
  10. }
複製代碼
當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。; ?& ^9 _7 _& H4 F; e
最後把函數勾到Wordpress初始化函數
  1. add_action('init', 'my_recent_posts_button');
複製代碼

, H3 K0 h" `9 M4.3 按鈕的用法
. R  p9 A, _% z* w' i* G
為了測試程式碼是否正確，我們打開一篇新的文章，這時一個我們剛剛定義的按鈕是不是已經出現在第一行的末尾了？如下圖所示：

; _7 x0 h3 K' ^+ D+ r9 |
點擊按鈕的時候，會彈出對話框讓我們輸入文章的數量：

5 [  ]5 Q& r$ O: c0 F
輸入完點擊確定後，會彈出第二個對話框，讓我們輸入列表的標題：
- M/ f! s  f8 |% s* M
參數留空的話，不會出現在最後的代碼中。最後，短代碼會新加到編輯器中：
2 S! e8 J+ V3 ^' l) y: p8 f
到此就大功告成了。想要增加其他功能的短代碼及按鈕可以參考上面的教學，如法炮製舉一反三，相信可以製作出符合各位需求的短代碼功能。
參考文章: 1 2




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