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

標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕 [打印本頁]
作者: IT_man    時間: 2016-6-9 12:40
標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕
WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)4 i+ v! q7 L; j
. R# i4 F/ i8 n/ l9 M- q
wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
3 J& `' B9 Z, I0 l6 E2 i* A以下是 wordpress 短代碼的詳细介紹及進階應用。; P/ Y8 G- a. F2 c! W. b

; m1 P6 S+ k  i$ k4 J4 x" {5 R短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :4 H1 A2 V7 ~. {- P/ h& x9 c
  1. [recent-posts]
複製代碼
此外 , 我們可以設定一個參數來控制文章的數量 :
4 r; \) l% Q8 Z/ n& ?1 f: V
  1. [recent-posts posts="5"]
複製代碼
此外 , 我們也可以為文章列表新增一個標題 :, ]4 b; R; t" Z( |' p& t$ x8 D
  1. [recent-posts posts="5"]Posts Heading[/recent-posts]
複製代碼
1 f4 Y% E( S; ?5 l- J9 t

# S4 n) x6 ?# ~7 D5 B0 \4 }. n1. 簡單的短代碼
3 A* r0 ^2 n+ h5 Y$ L. ~本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
* p1 L- i/ s' J
  1. [recent-posts]
複製代碼
該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
1 S" w. {9 q! A$ l, I- ^: Z; G6 q1 Z& o
+ f7 H- a7 f9 u( n2 e本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。; i0 I6 m0 N1 }$ n5 o: r7 E
1.1 建立返回函數, P- U2 ?& v' X4 n  T( \
當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
; X0 |8 l4 q5 {, y5 l$ k' {
  1. function recent_posts_function() {
    : E, l2 ?8 S2 |- x) I0 s( A0 J
  2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
    / f/ L% u9 E0 i6 i8 a! K9 l
  3.         if (have_posts()) :
    # M' v1 Q/ X  }' @
  4.                 while (have_posts()) : the_post();) Z- x( S, {3 J' H( k. l( A- H
  5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';: r) K( h3 T1 `  `5 D. P2 G
  6.                 endwhile;
    5 X5 l4 a: G. X% A1 w
  7.         endif;- w3 S" E- H. S% Q# b6 g
  8.         wp_reset_query();
    : u/ ^& H7 [  k9 A/ x2 k; p
  9.         return $return_string;
    " {8 I7 e3 h) D' h7 I
  10. }
複製代碼
如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。4 M3 K/ U  z5 V% i1 M

; U% {/ n. y0 D5 G' l* N3 T7 H1 e/ r
1.2 註册短代碼0 W5 ?, D  f) a
現在，我們告訴Wordpress這個函數是一個短代碼：
  1. function register_shortcodes(){' j9 D; d) n& J. b! G9 j
  2.         add_shortcode('recent-posts', 'recent_posts_function');2 ?8 A: Z, U, {# Q3 }' F& g" z
  3. }
複製代碼
當在文章的內容中使用短代碼
* W1 e; l  p. q4 W8 }
  1. [recent-posts]
複製代碼
將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。3 Q, Y0 Y4 B+ G1 e7 o; C
' ?0 |- e- Z0 x/ f" M! H. I
4 a$ Z+ }% ^! o) |
1.3 Hook into WordPress
" {) _- P0 b# u+ e9 q, y3 A4 C/ X+ b5 S* \$ G( \
為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。3 @( v7 P% l1 \; V$ c
  1. add_action( 'init', 'register_shortcodes');
複製代碼

  z& w6 o$ r- m+ I* g9 }1.4 測試短代碼, ~' ]8 v3 w- X5 Z1 @: R* \5 w8 b
簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :
  1. [recent-posts]
複製代碼
2. 進階短代碼
2.1 短代碼参數
短代碼是非常有彈性 , 因為它讓我們加入參數可讓它們有更多的功能。 假設我們必須要顯示某一特定數量的最新的文章。 為了達到這個目的 , 我們需要給短代碼指定其他選項以顯示最近的文章數。
我們需要使用兩個函數 ,第一個是內建在 wordpress 的shortcode _ atts ( ) 函式 , 它把用戶的短代碼屬性與本地屬性結合在一起 , 並填入到想要的位置。 第二個是 PHP的extract() 函数 , 顧名思義 , 它萃取出短代碼中的各個屬性。
展開我們的返回功能 , 我們新增一個參數 $atts, 它是一個陣列,從中可以提取到我們需要的文章數。 我們查詢資料庫來取得指定數目的文章 , 並傳回一個列表 :
  1. function recent_posts_function($atts){: m4 H& L, j6 Y
  2.         extract(shortcode_atts(array(; F% P9 E& f( ]  z4 U
  3.                 'posts' => 1,
    - }2 u, E' k; m& p) Q3 M9 H+ b
  4.         ), $atts));
    ( w$ \; Q0 n- X0 Z! |

  5. & G4 [) O  x% z; H( {; O3 ?
  6.         $return_string = '<ul>';! c) k/ R% \* c# Z2 [3 F3 v
  7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
    ; {! E& y2 ^- T
  8.         if (have_posts()) :. h1 c" l* ~5 |5 @- @. w
  9.                 while (have_posts()) : the_post();
    , a2 H3 |- K( z3 j! ~7 _2 l4 @
  10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';. G8 q0 {: k9 b2 h0 n
  11.                 endwhile;7 S. E( ^* M2 G
  12.         endif;5 f5 F* X- y. A: w+ ]& p9 }
  13.         $return_string .= '</ul>';1 \( t" J0 ?) N, ?; E8 B) c; ~

  14. $ }1 Y, R( a; b* S
  15.         wp_reset_query();% y4 D% k8 u4 J8 b3 t$ [( o
  16.         return $return_string;: N  E$ d" F* \% |) A% q9 K! l) o& Z
  17. }
複製代碼
如果使用者未指定此選項 , 1 將是預設值。 我們可以加入多個屬性使短代碼接受更多的參數。 使用這項強化函數 , 我們就可以指定調用最新文章的數量 :
  1. [recent-posts posts="5"]
複製代碼
當顯示於瀏覽器 , 您就可以看到最近的五篇文章列表

! M+ X3 o+ Z7 J  z2.2 短代碼中增加内容
我們可以繼續擴展我們的短代碼、新增一些內容作為參數 來傳遞, 例如"最新文章列表的標題"。 若要達成此目的 , 我們需要在返回函數中新增第二個參數$content , 並把它顯示在列表前面的一個 <h3> 標簽中。新的函數如下：
  1. function recent_posts_function($atts, $content = null) {* k. G5 j6 ~, D- S% P
  2.         extract(shortcode_atts(array(# l# S4 m: Z0 k4 M* Z- a# }
  3.                 'posts' => 1,  R- W$ ]1 V5 n3 t2 z+ N. k
  4.         ), $atts));1 a% j2 y! H9 I1 G' {

  5. ; r. [' f$ ]& U  J) E# [1 p  [
  6.         $return_string = '<h3>'.$content.'</h3>';
    6 P0 [1 ?3 K6 l2 l9 q- b
  7.         $return_string .= '<ul>';7 e& h& y) i4 J( o: t/ e* ]) }  P
  8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
    : a' e( l  X4 c+ ^% Q7 G# {
  9.         if (have_posts()) :
    & b" I8 C, Y) e
  10.                 while (have_posts()) : the_post();
    2 m# Y  G% r- q
  11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';/ }, Y" `1 d  }
  12.                 endwhile;
    7 W6 o; t! o1 n3 o) Q& x
  13.         endif;( C( a3 r4 |' j8 [5 `5 Z+ N0 w, ^
  14.         $return_string .= '</ul>';# W- p& Q, b) e1 V# {

  15. " [& ?5 C2 A: s0 V& N  p% Z) m
  16.         wp_reset_query();- i  \) C3 L+ _- S5 T
  17.         return $return_string;0 x6 n9 H+ q  p0 D$ f) Y
  18. }
複製代碼
這種短代碼類似於一個HTML標簽：
  1. [recent-posts posts="5"]This is the list heading[/recent-posts]
複製代碼
除了文章列表多了一個標題，其餘的內容和上一個示例是一樣的：
% X+ y# @0 h% `
3. 在任何地方顯示短代碼
3.1 在側邊攔小工具中使用短代碼
預設情況下 , 側邊欄小工具是忽略短代碼的，您可以將此程式碼放在小工具

3 e' s8 m+ G( ?! D
我們可以採用一行程式碼來啟用這個函數 , 為了使側邊欄小工具支援短代碼 , 新增以下的程式碼 :
  1. add_filter('widget_text', 'do_shortcode');
複製代碼
現在不需要修改任何其他地方 , 刷新頁面, 側邊欄將會正確地顯示
& I* J0 w) j4 p( {4 ~/ U+ c; l
同樣的，在評論中啟用短代碼：
  1. add_filter( 'comment_text', 'do_shortcode' );
複製代碼
在摘要中啟用短代碼：
  1. add_filter( 'the_excerpt', 'do_shortcode');
複製代碼
4. TinyMCE編輯器增加短代碼按鈕+ Y, @/ s4 d' V: ^8 y. n8 Z

0 n- m, W: @  N* A/ o" C# `雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。
要解決這個，我們可以給 TinyMCE編輯器增加一個按鈕，使用戶可以透過簡單的點擊來增加短代碼。建立這個按鈕僅需兩個步驟：

3 {1 L* }, r2 i$ n; T2 p7 [4.1 透過JS文件來建立按鈕
JS文件是透過 TinyMCE API 來註冊 TinyMCE 插件的。我們在主題的 js 目錄下(/wp-content/themes/你主題名稱/js/)建立 recent-posts.js ，並貼進去下面的代碼（需要把按鈕圖片檔(/wp-content/themes/你主題名稱/js/recentpostsbutton.png)也放在同一個目錄）：
  1. (function() {
    / C$ J( u3 t7 e- r" b
  2.         tinymce.create('tinymce.plugins.recentposts', {
    4 u. f8 ^, D  q7 k. C
  3.                 init : function(ed, url) {4 W; @" H- B! n4 u0 P$ D" t6 F9 O  a. |
  4.                         ed.addButton('recentposts', {
    5 r/ S+ `1 E1 x" ?( N
  5.                                 title : 'Recent posts',) j& j# r( Z6 _: f
  6.                                 image : url+'/recentpostsbutton.png',9 @8 a$ j2 H( ?8 Z8 I
  7.                                 onclick : function() {
    7 K2 o. f3 ]9 K7 |& \9 Y- g
  8.                                         var posts = prompt("文章數量", "1");
    ( K4 z; a+ @. y* S! Z
  9.                                         var text = prompt("請填入列表標題", "最新文章");
      O: N  L7 p1 a, C/ r

  10. * N; I# Y& l! v% H7 R
  11.                                         if (text != null && text != ''){3 j% R) p/ Q+ ^- `7 i2 d' k0 i
  12.                                                 if (posts != null && posts != '')- r2 r) Q4 F+ U6 J% Q  B
  13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    ; B, \: u* Q0 u9 Q0 K6 H0 K
  14.                                         else3 b( ^# K5 l( u- G; f
  15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');) ^; ~- [1 D+ ^& D! ^  H5 ^
  16.                                         }) d$ w# d- r, w/ P' x- n9 k) ^
  17.                                         else{
    7 Q4 ]9 ]/ c/ n$ S$ m9 ]
  18.                                                 if (posts != null && posts != '')
    5 }* l9 S: v1 @; o1 F5 o" J. F
  19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    3 q0 Y6 W2 J1 |
  20.                                                 else
    " B3 i9 B% N' D( ]' b  u
  21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
      ~5 j8 e0 y# K, n
  22.                                         }3 ~% Y& ~/ O" e% E; ?' o
  23.                                 }
    : |8 D/ t3 K4 A
  24.                         });
    9 ?( C4 `  d# U) \! |
  25.                 },
    ( O5 @+ n+ K. r7 L( i9 B6 G9 u
  26.                 createControl : function(n, cm) {
    / ]7 E4 u0 R. M. i) L
  27.                         return null;& v, e. M- k) l8 ?, E7 U# \
  28.                 },8 X. m8 ~( {- d
  29.                 getInfo : function() {
    2 _# Z, r; x4 c
  30.                         return {' z0 @, E* l$ J6 Y% Z% q
  31.                                 longname : "Recent Posts",
    : H$ }$ w! p6 R$ ~" V
  32.                                 author : 'Specs',
    & Q+ i6 u) s6 X4 t
  33.                                 authorurl : 'http://9iphp.com',6 F# {1 D% N; C" j3 P
  34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    ; e+ |# z, Y0 E
  35.                                 version : "1.0"7 }  q4 p& p5 {5 y8 ~2 k
  36.                         };/ j; q/ P3 \1 a$ o' W) E
  37.                 }$ R; V- W$ v" K  _$ J
  38.         });5 o3 h, c7 E7 }- E% @6 y0 F
  39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    6 K+ t5 `: V5 @  Q: \1 p9 x- k3 d
  40. })();
複製代碼
我們透過呼叫 tinymce.create() 建立了一個插件。代碼中最重要的是 init() 函數，我們定義了一個名字，一個icon文件及 onclick() 事件處理程序。
在 onclick() 函數的前兩行，依序彈出兩個對話框讓用戶輸入文章數量及列表標題兩個參數，然後根據用戶輸入，把短代碼插入到編輯器中。
最後，TinyMCE插件透過 add() 函數增加到 PluginManager。現在我們已經成功的整合了 [recent-posts] 短代碼到Wordpress中。

9 g# ^, a) N1 T1 O
4.2 註冊按鈕及TinyMCE插件
0 v- x  ^9 I+ T* E* X9 T8 Z5 h+ |% r2 m* w; H
當您完成建立的JS 檔 , 我們現在需要註冊它和短代碼按鈕。 因此我們建立了兩個函數並把它們繫結至適當的 wordpress 過濾器中。
第一個叫做 register_button() 的函數把短代碼增加到按鈕陣列中，在現有按鈕和新按鈕之間增加分割線。
  1. function register_button( $buttons ) {
    5 w5 a  V9 E- _- d, H8 r0 ~
  2.         array_push( $buttons, "|", "recentposts" );
    7 D1 S/ ~' V/ N3 Z, Z
  3.         return $buttons;
    5 z3 j" p3 c! q. c; }- [
  4. }
複製代碼
第二個函數 add_plugin() 指定JS文件的路徑及文件名。* V+ P5 U% m% h
  1. function add_plugin( $plugin_array ) {  q5 O2 L  E* Q7 G" T5 T
  2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
    / ]+ r- _0 k& d) {2 L) |
  3.         return $plugin_array;/ m1 n' a# o: m8 }4 f) H/ f9 }
  4. }
複製代碼
下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。9 F5 v6 d% `3 Y' B! B. J' z7 f& H7 w
  1. function my_recent_posts_button() { 4 f4 Z% e7 m( N
  2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
    : _9 J: X5 I' G7 {" a' Y
  3.                 return;
    - A4 _1 v% I% O. |0 @  v  G
  4.         }
    7 S5 m2 w7 B% ?* z. {/ a  P! Y

  5. . E/ b5 k! e; x& w7 C2 s1 r
  6.         if ( get_user_option('rich_editing') == 'true' ) {
    . u7 s  m& V6 j: T! c: m2 k3 B! r
  7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
    ( `3 p' |1 I" ^) k/ O5 ?
  8.                 add_filter( 'mce_buttons', 'register_button' );9 `  {% P) r+ L
  9.         } 4 F6 U- \) U: h
  10. }
複製代碼
當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。$ }( i" C. {8 I* Y9 u" s4 k
最後把函數勾到Wordpress初始化函數
  1. add_action('init', 'my_recent_posts_button');
複製代碼
4 _5 z. y  u$ ]( e1 U( c
4.3 按鈕的用法

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

9 D9 ?" v: _5 y; H. R0 P) l2 g
點擊按鈕的時候，會彈出對話框讓我們輸入文章的數量：
% o+ p* r0 y: \6 r3 H4 n+ t* h% M0 }
輸入完點擊確定後，會彈出第二個對話框，讓我們輸入列表的標題：
6 Z7 T, I& U6 p' v9 m) m
參數留空的話，不會出現在最後的代碼中。最後，短代碼會新加到編輯器中：

( n+ h$ M' ~+ b; z6 y. ]* R2 A
到此就大功告成了。想要增加其他功能的短代碼及按鈕可以參考上面的教學，如法炮製舉一反三，相信可以製作出符合各位需求的短代碼功能。
參考文章: 1 2




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