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

標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕 [打印本頁]
作者: IT_man    時間: 2016-6-9 12:40
標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕
WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
  E2 y2 ?  a2 I9 ~: {/ A1 a8 u
0 }4 r; S; x! r$ }. |/ Bwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
- p  t: _9 N7 k以下是 wordpress 短代碼的詳细介紹及進階應用。
% g5 x8 p1 s" J6 E/ n7 D4 W: Z; a6 O! d3 L! v
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :, `1 K: e1 C6 q# h1 E  w
  1. [recent-posts]
複製代碼
此外 , 我們可以設定一個參數來控制文章的數量 :
3 p1 }  y( C1 ~( Q: y4 z5 Z' @9 @1 Z* h5 m
  1. [recent-posts posts="5"]
複製代碼
此外 , 我們也可以為文章列表新增一個標題 :9 ]4 M# M' ~  V+ F3 U6 y- P
  1. [recent-posts posts="5"]Posts Heading[/recent-posts]
複製代碼

/ A( M2 x& |3 B7 s5 A* a/ @0 [4 H+ p# w; y0 t0 S
1. 簡單的短代碼% {! Q3 z2 O+ i' t: v6 O
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :1 X$ l& `6 h4 V/ I
  1. [recent-posts]
複製代碼
該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
2 ^1 Y4 ^6 o8 x8 t& {- O7 i; ^3 d
本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
# ]+ @9 F2 d8 ~$ o( j1.1 建立返回函數
4 [) l" Y6 E. T; J8 j) A  R* n( @當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。" E) ]6 H, t0 b6 Z! E! f# Q
  1. function recent_posts_function() {
    5 ?& y% @% p7 p3 g$ F8 R
  2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
    6 l, C+ |! l1 Q$ e# c
  3.         if (have_posts()) :
    , y) T  x/ T- h* T' A
  4.                 while (have_posts()) : the_post();" t7 K% J. y7 g5 m
  5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
    9 e! o" J8 X) Y  }0 }* ~- c5 M7 H
  6.                 endwhile;
    ' k5 D; a- X" n, v
  7.         endif;
    5 I; _9 d  t7 H; U  q  H$ x; m
  8.         wp_reset_query();
    " f% w: \/ o. I" ~6 @, s$ D! _9 `
  9.         return $return_string;5 o2 R2 u) a; e# Z7 Q
  10. }
複製代碼
如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。; V: f+ R' k  G. l# H
/ l! Y& n9 X) \* v0 ^/ ~% c
, v2 g! c5 F9 u6 K7 F* d2 X. {
1.2 註册短代碼! l+ p7 @5 I% P4 {
現在，我們告訴Wordpress這個函數是一個短代碼：
  1. function register_shortcodes(){7 K. b% z/ ~7 y
  2.         add_shortcode('recent-posts', 'recent_posts_function');
    , m) a, E. u9 R/ M/ @. I
  3. }
複製代碼
當在文章的內容中使用短代碼6 s$ c6 N8 W1 G, ^$ P
  1. [recent-posts]
複製代碼
將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。' z/ l  O  q* b7 r$ k
0 v& v/ t1 s4 }) M' o8 u$ F( z% \; C

3 J: g; V" r* y1 r1.3 Hook into WordPress
) |8 X+ m" X* n3 e
* e* n9 E5 N; z5 A1 w& u為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。  L- Y9 c: r- }& X0 i
  1. add_action( 'init', 'register_shortcodes');
複製代碼

* A+ v- Z: j2 U' C- N1.4 測試短代碼
- E/ c5 X  b7 H# C4 u1 o) A簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :
  1. [recent-posts]
複製代碼
2. 進階短代碼
2.1 短代碼参數
短代碼是非常有彈性 , 因為它讓我們加入參數可讓它們有更多的功能。 假設我們必須要顯示某一特定數量的最新的文章。 為了達到這個目的 , 我們需要給短代碼指定其他選項以顯示最近的文章數。
我們需要使用兩個函數 ,第一個是內建在 wordpress 的shortcode _ atts ( ) 函式 , 它把用戶的短代碼屬性與本地屬性結合在一起 , 並填入到想要的位置。 第二個是 PHP的extract() 函数 , 顧名思義 , 它萃取出短代碼中的各個屬性。
展開我們的返回功能 , 我們新增一個參數 $atts, 它是一個陣列,從中可以提取到我們需要的文章數。 我們查詢資料庫來取得指定數目的文章 , 並傳回一個列表 :
  1. function recent_posts_function($atts){3 [/ c/ f; E/ c/ O
  2.         extract(shortcode_atts(array(5 z$ P& W4 o9 o- S, ?5 u
  3.                 'posts' => 1,8 z, C  N1 f+ R# N" y0 T
  4.         ), $atts));4 @6 p+ ]8 F$ B
  5. & b7 p/ a- s6 @, s. [+ @
  6.         $return_string = '<ul>';
    ' G- M8 i# e# ~5 |. C; L- b$ Z
  7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
    3 x  Y0 r( `& E$ V- T$ [
  8.         if (have_posts()) :7 D: M& `( c0 p' M7 v
  9.                 while (have_posts()) : the_post();
    & p% ~+ `# Z( g" ?$ T
  10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';! j7 i) V! O2 }0 W' S% t- R
  11.                 endwhile;
    * r) c; l0 }5 s4 b9 u
  12.         endif;
    - `) K) Z4 K8 W
  13.         $return_string .= '</ul>';
    - @1 f( s! ^2 w' P& T0 f
  14. 5 d: m& E! I5 r' H) K
  15.         wp_reset_query();
    ' N0 s, ^& @& V* B, _
  16.         return $return_string;
    ; k  z- P9 W' e7 L8 e( i3 |
  17. }
複製代碼
如果使用者未指定此選項 , 1 將是預設值。 我們可以加入多個屬性使短代碼接受更多的參數。 使用這項強化函數 , 我們就可以指定調用最新文章的數量 :
  1. [recent-posts posts="5"]
複製代碼
當顯示於瀏覽器 , 您就可以看到最近的五篇文章列表
7 D3 V! |& r& y' z- X" A
2.2 短代碼中增加内容
我們可以繼續擴展我們的短代碼、新增一些內容作為參數 來傳遞, 例如"最新文章列表的標題"。 若要達成此目的 , 我們需要在返回函數中新增第二個參數$content , 並把它顯示在列表前面的一個 <h3> 標簽中。新的函數如下：
  1. function recent_posts_function($atts, $content = null) {$ D/ \' S; [$ }$ |" e. w
  2.         extract(shortcode_atts(array(# y6 h$ w9 s; z3 v# A, Q
  3.                 'posts' => 1,' r, F, V/ u- t9 k$ M
  4.         ), $atts));) a  R- ~3 m) H& \. y" b7 N. `
  5. % x3 ?0 t4 j& u3 m7 q" r
  6.         $return_string = '<h3>'.$content.'</h3>';
    4 d- L: N! {; g+ K/ H: {% N
  7.         $return_string .= '<ul>';  ^  i# ?! |3 Q( F" Y. M5 U
  8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));" e* J& E- E6 o1 _7 [8 G
  9.         if (have_posts()) :
    - L$ I! k. l9 y  `+ k# k/ x
  10.                 while (have_posts()) : the_post();
    4 z8 B8 p+ i% _5 E) ]2 o
  11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    - R  C: i  W2 P( H
  12.                 endwhile;( e/ i3 o* O- H  [+ N3 C
  13.         endif;
    , @- W! k# ^' {- O: q( j3 X4 s
  14.         $return_string .= '</ul>';% G7 S' \& i* S5 V9 ?* F$ n5 ?. ~

  15. 1 }0 W5 X- g& c8 G
  16.         wp_reset_query();5 k$ C' F) k" g0 m6 \* u
  17.         return $return_string;
    1 p' P( u. _1 H
  18. }
複製代碼
這種短代碼類似於一個HTML標簽：
  1. [recent-posts posts="5"]This is the list heading[/recent-posts]
複製代碼
除了文章列表多了一個標題，其餘的內容和上一個示例是一樣的：
( y2 W8 k/ g3 e+ W' W) ]: o* @; J" ^$ T
3. 在任何地方顯示短代碼
3.1 在側邊攔小工具中使用短代碼
預設情況下 , 側邊欄小工具是忽略短代碼的，您可以將此程式碼放在小工具

: ]2 K' V% F. w( w* n
我們可以採用一行程式碼來啟用這個函數 , 為了使側邊欄小工具支援短代碼 , 新增以下的程式碼 :
  1. add_filter('widget_text', 'do_shortcode');
複製代碼
現在不需要修改任何其他地方 , 刷新頁面, 側邊欄將會正確地顯示
# f0 ^! R5 k7 v2 ]; q2 x1 F
同樣的，在評論中啟用短代碼：
  1. add_filter( 'comment_text', 'do_shortcode' );
複製代碼
在摘要中啟用短代碼：
  1. add_filter( 'the_excerpt', 'do_shortcode');
複製代碼
4. TinyMCE編輯器增加短代碼按鈕, M) K! K' g! z) G) j" |

# b) X) C7 M, ^雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。
要解決這個，我們可以給 TinyMCE編輯器增加一個按鈕，使用戶可以透過簡單的點擊來增加短代碼。建立這個按鈕僅需兩個步驟：
% o( q  ~6 @/ R; c3 [* `/ @& e
4.1 透過JS文件來建立按鈕
JS文件是透過 TinyMCE API 來註冊 TinyMCE 插件的。我們在主題的 js 目錄下(/wp-content/themes/你主題名稱/js/)建立 recent-posts.js ，並貼進去下面的代碼（需要把按鈕圖片檔(/wp-content/themes/你主題名稱/js/recentpostsbutton.png)也放在同一個目錄）：
  1. (function() {
    / a/ ?! h( C, n* v. F
  2.         tinymce.create('tinymce.plugins.recentposts', {" |1 f, G6 i* ]& c
  3.                 init : function(ed, url) {
    , ~* N' w5 y, g2 |! f. ]6 [+ F
  4.                         ed.addButton('recentposts', {
    ! U" H6 |3 [% o: k2 e' h
  5.                                 title : 'Recent posts',7 o1 H, B1 e' }  r' a* s/ V6 h
  6.                                 image : url+'/recentpostsbutton.png',
    , d* s. A5 j0 v! ^% C
  7.                                 onclick : function() {
    ; f9 i/ ]& f: Y: C( H* T5 X
  8.                                         var posts = prompt("文章數量", "1");  r! L0 ^" a! ~, t1 b
  9.                                         var text = prompt("請填入列表標題", "最新文章");" u+ B/ y5 R8 q$ i# k/ C+ r/ f

  10. 5 Y4 f1 l+ i1 {  O+ N
  11.                                         if (text != null && text != ''){7 N* Z( S0 n9 S6 e0 e" D+ s
  12.                                                 if (posts != null && posts != '')
    5 }! q) m! e" r
  13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');7 k$ x- c3 C9 z6 w* _
  14.                                         else
    . x- p/ _( m6 u+ l3 _: p2 U, G
  15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    % A" B  q# z9 l; N/ _- w- b
  16.                                         }  B0 ]4 B7 d7 {% \: g. K6 ?2 D$ z' @) p) B
  17.                                         else{
    # M# y1 g9 V; ?7 T, j$ b3 G# K* e
  18.                                                 if (posts != null && posts != '')* k8 g0 l7 K- v+ v- r
  19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');# q. o7 n1 E. b& u$ ]1 z# t/ l
  20.                                                 else( h2 y5 d' v3 x2 q6 A; ^
  21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
      a" b5 j) c' @: ?
  22.                                         }
      a+ L3 {7 u' P3 m
  23.                                 }
    , q  Y2 j; V  o- J. p& S
  24.                         });6 c" L- \/ ?/ v/ V/ O
  25.                 },, Y/ C% [; f; g. _5 P% W. Q
  26.                 createControl : function(n, cm) {
    / t. ]" M( g3 W2 U) [5 q# v
  27.                         return null;4 ^2 Q/ H9 D5 I5 D
  28.                 },( v! N. p- |+ x/ X' ?
  29.                 getInfo : function() {" |& t* T/ n( U2 \; t, t
  30.                         return {/ A9 ^2 y' J' w9 }/ U( ?; G
  31.                                 longname : "Recent Posts",
    - F5 X9 Y8 y7 p5 {  S  E6 Q. c) T6 q
  32.                                 author : 'Specs',0 w1 F5 [; d# p& K0 g$ ^
  33.                                 authorurl : 'http://9iphp.com',
    & ^- v; m4 @7 M" A
  34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    , J; H1 X& t# V
  35.                                 version : "1.0"; Y  R7 a' l5 z2 t* r4 M  a% n
  36.                         };5 g4 ?( U: j: W
  37.                 }
    ; [! Y0 \/ F& \" y
  38.         });( G# [: C  G2 {- A$ `
  39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    - o# C. r" h8 G
  40. })();
複製代碼
我們透過呼叫 tinymce.create() 建立了一個插件。代碼中最重要的是 init() 函數，我們定義了一個名字，一個icon文件及 onclick() 事件處理程序。
在 onclick() 函數的前兩行，依序彈出兩個對話框讓用戶輸入文章數量及列表標題兩個參數，然後根據用戶輸入，把短代碼插入到編輯器中。
最後，TinyMCE插件透過 add() 函數增加到 PluginManager。現在我們已經成功的整合了 [recent-posts] 短代碼到Wordpress中。

& p2 T9 q: ]* K; \0 ^$ S
4.2 註冊按鈕及TinyMCE插件/ K) u& m7 y1 \. z- H( I
- G0 v+ t2 L+ F4 @* N9 z. Y
當您完成建立的JS 檔 , 我們現在需要註冊它和短代碼按鈕。 因此我們建立了兩個函數並把它們繫結至適當的 wordpress 過濾器中。
第一個叫做 register_button() 的函數把短代碼增加到按鈕陣列中，在現有按鈕和新按鈕之間增加分割線。
  1. function register_button( $buttons ) {
    . z* \# l8 i, H8 O: Y
  2.         array_push( $buttons, "|", "recentposts" );
    / \9 A2 w, n$ a5 d6 [- F' ]& A
  3.         return $buttons;
    ! w& ^* ]6 V6 f  W# V: S
  4. }
複製代碼
第二個函數 add_plugin() 指定JS文件的路徑及文件名。8 W4 c& u, `8 W
  1. function add_plugin( $plugin_array ) {9 Z) _1 @9 l3 H$ m* s
  2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';8 J* `, `" |+ T
  3.         return $plugin_array;
    " k6 D2 R, C8 X; G: j2 ~4 ^* ?  N
  4. }
複製代碼
下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。  m: l# [% o: c5 I# g2 ]1 g9 I" p1 X2 v
  1. function my_recent_posts_button() {
    3 @' M1 A7 W$ R- k
  2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {2 M3 Q# [! e6 j" ~' }; ^- f* G
  3.                 return;8 h" e* |; O4 a! D$ U0 V! J7 \
  4.         }) P; \0 A; {: s4 J$ b
  5.   \. X7 Y' X+ a; i; _. `, z6 h
  6.         if ( get_user_option('rich_editing') == 'true' ) {
    ! s4 i' J6 r. L+ D+ Q* A
  7.                 add_filter( 'mce_external_plugins', 'add_plugin' );  d: V8 a; v0 }* V1 w* F
  8.                 add_filter( 'mce_buttons', 'register_button' );
    9 q$ O6 `7 ?' C7 V  ?, I& I
  9.         } + g. ~8 l8 S4 v  _
  10. }
複製代碼
當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。: y* ]  G. k  ]0 H7 f6 [
最後把函數勾到Wordpress初始化函數
  1. add_action('init', 'my_recent_posts_button');
複製代碼

6 l- A* h) N5 D- D4.3 按鈕的用法

' B3 d% s' }3 B( D- s
為了測試程式碼是否正確，我們打開一篇新的文章，這時一個我們剛剛定義的按鈕是不是已經出現在第一行的末尾了？如下圖所示：
7 r5 Z( k. q' M! B
點擊按鈕的時候，會彈出對話框讓我們輸入文章的數量：
+ D% C3 _7 w7 q, \0 G5 m& t
輸入完點擊確定後，會彈出第二個對話框，讓我們輸入列表的標題：

: M9 t2 I4 h! v# V% q9 J
參數留空的話，不會出現在最後的代碼中。最後，短代碼會新加到編輯器中：
1 [/ F- A& S5 B7 U% `
到此就大功告成了。想要增加其他功能的短代碼及按鈕可以參考上面的教學，如法炮製舉一反三，相信可以製作出符合各位需求的短代碼功能。
參考文章: 1 2




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