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

標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕 [打印本頁]
作者: IT_man    時間: 2016-6-9 12:40
標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕
WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)0 v0 F% ?9 k8 p8 D% q# t( [% w- B
$ z8 a+ y# u* ?8 k
wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
2 j* D8 X% ^/ T0 i+ `以下是 wordpress 短代碼的詳细介紹及進階應用。  A8 N( T+ q5 a  a7 _  }8 a+ @3 p

2 C3 u, c0 S. Q* W短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
3 q! I7 ~  z7 m5 k. }7 k
  1. [recent-posts]
複製代碼
此外 , 我們可以設定一個參數來控制文章的數量 :
2 c' Y% t* d$ Z. M4 ~" k" s
  1. [recent-posts posts="5"]
複製代碼
此外 , 我們也可以為文章列表新增一個標題 :0 x$ a1 R; M5 J  P/ N' k. k( w1 v
  1. [recent-posts posts="5"]Posts Heading[/recent-posts]
複製代碼
0 S: V- F  _7 E1 g: q
; G! S( _4 [7 L" l8 a9 R
1. 簡單的短代碼
5 Z. v4 U- O5 n! C3 P7 K3 B2 }本教學的第一部分 , 我們會建立下列短代碼的程式碼 :* ^' E) ?% h) N1 ^0 p
  1. [recent-posts]
複製代碼
該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :! q( P8 [/ u1 X. Y( c0 d
1 w/ a2 s' i" i/ G3 _& N; s
本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。& S# Y. ?% ?  T1 O+ R
1.1 建立返回函數
! s3 o, J" M/ v- M當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。
2 H* o' F, l* M! e
  1. function recent_posts_function() {
    7 ?* V' J  U( u! u- S6 _- h
  2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
    * n' E4 o* Z( p, T2 [
  3.         if (have_posts()) :: L$ C+ |1 {$ j. v( @6 h$ y
  4.                 while (have_posts()) : the_post();
    1 X$ g7 x" h9 b- K/ z6 n+ z
  5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
    ; y& o7 w( J  |( L
  6.                 endwhile;1 ~5 E: H+ H. i2 v* ^5 H
  7.         endif;# g$ Z. M8 p2 j7 n: s
  8.         wp_reset_query();, g  Y; N" W4 g2 [
  9.         return $return_string;
    $ q' F) n( a4 y6 O9 {9 N" L) H. v
  10. }
複製代碼
如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
& N* f% @4 R" Q( B6 ]
& ?7 u8 {" d" B# q( I1 B/ Y/ F6 N+ X1 i  _
1.2 註册短代碼/ t4 q5 a" [8 l! M
現在，我們告訴Wordpress這個函數是一個短代碼：
  1. function register_shortcodes(){5 S+ X" D- Q7 d
  2.         add_shortcode('recent-posts', 'recent_posts_function');
    - b8 [5 |" \: c7 w( C0 [4 G
  3. }
複製代碼
當在文章的內容中使用短代碼
4 i. r0 @9 N6 q0 z* |; [
  1. [recent-posts]
複製代碼
將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。
1 L) j. S' l, Y* N3 i
. S9 E( k' e, A. b) d+ e) ^
- ?& g# y2 E6 E% i; i7 d$ X( n' Y1.3 Hook into WordPress
+ V, J+ V# g' ?  W+ R  c( i4 e) n
為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
0 x" G" Z9 Y8 o8 T/ S4 W* Z
  1. add_action( 'init', 'register_shortcodes');
複製代碼

1 b, {: @; O( F: B% {! _1.4 測試短代碼
1 S/ ~4 I! V# t' [8 t簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :
  1. [recent-posts]
複製代碼
2. 進階短代碼
2.1 短代碼参數
短代碼是非常有彈性 , 因為它讓我們加入參數可讓它們有更多的功能。 假設我們必須要顯示某一特定數量的最新的文章。 為了達到這個目的 , 我們需要給短代碼指定其他選項以顯示最近的文章數。
我們需要使用兩個函數 ,第一個是內建在 wordpress 的shortcode _ atts ( ) 函式 , 它把用戶的短代碼屬性與本地屬性結合在一起 , 並填入到想要的位置。 第二個是 PHP的extract() 函数 , 顧名思義 , 它萃取出短代碼中的各個屬性。
展開我們的返回功能 , 我們新增一個參數 $atts, 它是一個陣列,從中可以提取到我們需要的文章數。 我們查詢資料庫來取得指定數目的文章 , 並傳回一個列表 :
  1. function recent_posts_function($atts){* G5 m7 ~0 C6 S* A
  2.         extract(shortcode_atts(array(  w1 J( p& u4 p5 b0 o* U. Y7 e
  3.                 'posts' => 1,
    ; S# w) q7 j5 s0 k' o
  4.         ), $atts));
    + A1 b$ S: l! e6 ~% H0 @

  5. 7 O# L9 e0 R( o* e
  6.         $return_string = '<ul>';5 ?, g4 J( \: }
  7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));7 I1 D) j9 s  i+ g" S& a3 G
  8.         if (have_posts()) :5 n* H; L2 n  ^: Z6 T# }
  9.                 while (have_posts()) : the_post();4 N( \9 u$ b1 i9 Y2 ]
  10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';5 b4 K1 `$ L/ z( J
  11.                 endwhile;2 L/ ]7 a5 G' R+ B  r# H
  12.         endif;
    ) U9 N( g- E: d; B
  13.         $return_string .= '</ul>';. c! {6 o3 N, `  J4 _

  14. 5 R6 q( |1 K2 p- T" V" h  c
  15.         wp_reset_query();9 S) _( P3 x6 x- r7 z# U
  16.         return $return_string;
    & L6 f4 b4 g% G& X! X
  17. }
複製代碼
如果使用者未指定此選項 , 1 將是預設值。 我們可以加入多個屬性使短代碼接受更多的參數。 使用這項強化函數 , 我們就可以指定調用最新文章的數量 :
  1. [recent-posts posts="5"]
複製代碼
當顯示於瀏覽器 , 您就可以看到最近的五篇文章列表

2 q3 H8 p4 o6 q9 I2.2 短代碼中增加内容
我們可以繼續擴展我們的短代碼、新增一些內容作為參數 來傳遞, 例如"最新文章列表的標題"。 若要達成此目的 , 我們需要在返回函數中新增第二個參數$content , 並把它顯示在列表前面的一個 <h3> 標簽中。新的函數如下：
  1. function recent_posts_function($atts, $content = null) {& L+ \' m! g' q! H+ J
  2.         extract(shortcode_atts(array(
    ' O. U, Y: l4 _/ s
  3.                 'posts' => 1,1 u6 i& ]! f3 v' b) ]6 Y3 e
  4.         ), $atts));
    / K+ \( o$ f0 L" y7 I

  5. " v. W& v1 j( x9 J* U, ^# i
  6.         $return_string = '<h3>'.$content.'</h3>';
    ! k( ]1 }  ?& K7 Y/ @
  7.         $return_string .= '<ul>';
    2 s0 {" a8 f* k+ l  w! b1 E+ R9 f
  8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));  `) h! y5 T/ }# a1 \
  9.         if (have_posts()) :% F0 K: I$ W8 w, B2 p
  10.                 while (have_posts()) : the_post();2 Z& I" Y4 L# V8 j( Q
  11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    / [2 Z% R4 V8 Q* K$ ]
  12.                 endwhile;
    - p: j1 E# \, ]' j
  13.         endif;
    7 U/ {& Z# x, c
  14.         $return_string .= '</ul>';
    3 w/ W) ]" M+ g5 W& y6 J6 y

  15. & Q/ q' |, H: R+ [: E
  16.         wp_reset_query();
    / U' E5 T* u3 Z! w$ x
  17.         return $return_string;
    / [0 E3 [! i, J2 a
  18. }
複製代碼
這種短代碼類似於一個HTML標簽：
  1. [recent-posts posts="5"]This is the list heading[/recent-posts]
複製代碼
除了文章列表多了一個標題，其餘的內容和上一個示例是一樣的：

" s; t* h  |4 Q7 ]) U; W
3. 在任何地方顯示短代碼
3.1 在側邊攔小工具中使用短代碼
預設情況下 , 側邊欄小工具是忽略短代碼的，您可以將此程式碼放在小工具
' `/ ?1 ~% T/ P" ]+ Y3 h9 G' p
我們可以採用一行程式碼來啟用這個函數 , 為了使側邊欄小工具支援短代碼 , 新增以下的程式碼 :
  1. add_filter('widget_text', 'do_shortcode');
複製代碼
現在不需要修改任何其他地方 , 刷新頁面, 側邊欄將會正確地顯示

3 N3 X* `1 m# c% g# [9 }& y
同樣的，在評論中啟用短代碼：
  1. add_filter( 'comment_text', 'do_shortcode' );
複製代碼
在摘要中啟用短代碼：
  1. add_filter( 'the_excerpt', 'do_shortcode');
複製代碼
4. TinyMCE編輯器增加短代碼按鈕5 B2 F3 Q4 s7 k3 `4 J
4 h6 M! X& s. E% L
雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。
要解決這個，我們可以給 TinyMCE編輯器增加一個按鈕，使用戶可以透過簡單的點擊來增加短代碼。建立這個按鈕僅需兩個步驟：

$ E- `" E* f( G' }2 K4.1 透過JS文件來建立按鈕
JS文件是透過 TinyMCE API 來註冊 TinyMCE 插件的。我們在主題的 js 目錄下(/wp-content/themes/你主題名稱/js/)建立 recent-posts.js ，並貼進去下面的代碼（需要把按鈕圖片檔(/wp-content/themes/你主題名稱/js/recentpostsbutton.png)也放在同一個目錄）：
  1. (function() {3 J- b" V4 A( }/ ^% l" B9 S
  2.         tinymce.create('tinymce.plugins.recentposts', {
    9 ]) X% V; s$ q" s1 N( y
  3.                 init : function(ed, url) {
    3 m8 t/ f3 v% g. P* i
  4.                         ed.addButton('recentposts', {  D3 l& Z0 P0 W; h
  5.                                 title : 'Recent posts',0 {6 p7 R8 V. z
  6.                                 image : url+'/recentpostsbutton.png',5 M6 S( w4 b( ~$ ?
  7.                                 onclick : function() {
    & J5 Y5 b: c' Q
  8.                                         var posts = prompt("文章數量", "1");( n! n; J# z0 E' w* e' {9 x# T
  9.                                         var text = prompt("請填入列表標題", "最新文章");- X- M" {* B; O9 q5 S( q: u
  10. 4 F; [7 R! ?, U. D- U! E9 g3 P7 @
  11.                                         if (text != null && text != ''){
    6 w! w9 C/ e) c8 t+ r# r6 A
  12.                                                 if (posts != null && posts != '')! }5 i9 L; N* m5 A
  13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');' C( Y1 r, w! ?" H0 V# `, G
  14.                                         else
    ) C2 e7 ]7 f5 G6 f% G; _6 O' z
  15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    . F- O! V( m1 r1 C. O$ q1 G7 R
  16.                                         }
    2 U0 i1 N0 _0 |5 [: v% ?* P, P# X$ {
  17.                                         else{$ ~2 B. N) Z+ {! Z, z. I* c
  18.                                                 if (posts != null && posts != '')
    - G3 {/ i8 X' H; Y& d- b
  19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    2 \8 e5 g4 l2 j" [
  20.                                                 else
    + [* M7 [- F6 h
  21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    2 B6 }% b# k$ |$ @* y% h: K6 ]
  22.                                         }
    0 k: C6 p' }" A
  23.                                 }
    ) `8 @( }; O8 `: P. v! ^' e! @
  24.                         });3 e9 G7 n3 T0 A) e. V( j! R
  25.                 },
    : W; c' L0 O7 a# ^/ S
  26.                 createControl : function(n, cm) {
    - _/ u3 ^$ N* v+ C$ V
  27.                         return null;
    ' f; Y& Z8 F% V+ q" h
  28.                 },
    ! i4 S, y" m5 \2 l1 _2 @
  29.                 getInfo : function() {) I5 b+ H- @9 g, C7 G) k! y
  30.                         return {% E, X6 g. z: o6 W
  31.                                 longname : "Recent Posts",# V- c% t4 l( Z  J' V! i. ]# t2 q
  32.                                 author : 'Specs',! j5 x+ s* b7 J; i
  33.                                 authorurl : 'http://9iphp.com',5 G! J) W6 u* h1 C0 Z: \$ e
  34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    / p1 k( A0 u8 T2 {
  35.                                 version : "1.0"
    , q$ m$ a/ g, u0 }. i
  36.                         };
    3 O( X! |( @. G  J4 B
  37.                 }/ I& f9 E& D9 V; b2 r1 u. N
  38.         });
    6 t0 G6 c1 Q8 s, B. n! C) H
  39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    1 @' R# u" s# w8 T
  40. })();
複製代碼
我們透過呼叫 tinymce.create() 建立了一個插件。代碼中最重要的是 init() 函數，我們定義了一個名字，一個icon文件及 onclick() 事件處理程序。
在 onclick() 函數的前兩行，依序彈出兩個對話框讓用戶輸入文章數量及列表標題兩個參數，然後根據用戶輸入，把短代碼插入到編輯器中。
最後，TinyMCE插件透過 add() 函數增加到 PluginManager。現在我們已經成功的整合了 [recent-posts] 短代碼到Wordpress中。

. h4 g5 K8 V- A# V$ U1 q# X2 E8 ~% q
4.2 註冊按鈕及TinyMCE插件
+ ^: f+ Y* X) s! A( _$ u2 B  T! d5 L8 U" \
當您完成建立的JS 檔 , 我們現在需要註冊它和短代碼按鈕。 因此我們建立了兩個函數並把它們繫結至適當的 wordpress 過濾器中。
第一個叫做 register_button() 的函數把短代碼增加到按鈕陣列中，在現有按鈕和新按鈕之間增加分割線。
  1. function register_button( $buttons ) {
    ; \  L6 t4 @. L" A6 d
  2.         array_push( $buttons, "|", "recentposts" );8 [0 H0 f0 U1 b( C. f8 f, H% m
  3.         return $buttons;" {7 {4 K* b. W2 o5 Y% E# j
  4. }
複製代碼
第二個函數 add_plugin() 指定JS文件的路徑及文件名。' M  H& j% U9 S. E2 X1 t7 A
  1. function add_plugin( $plugin_array ) {
    1 V+ ?- K; f- o" Y1 @# \2 B2 m
  2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
    9 `# @. p) F4 L: g
  3.         return $plugin_array;; ^$ I8 F0 W) E
  4. }
複製代碼
下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。
1 V; B; @/ {2 F  A! A# p
  1. function my_recent_posts_button() { 1 d& H+ F/ `% v1 d% {
  2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {* L3 b% D' ^" `+ \
  3.                 return;
    " b0 l# E1 w6 \
  4.         }0 ~# x- Q% V# H' x
  5. * g$ D: @! f  F$ E
  6.         if ( get_user_option('rich_editing') == 'true' ) {
    9 G3 u  f+ c" T7 p3 L! h5 r
  7.                 add_filter( 'mce_external_plugins', 'add_plugin' );3 g( R4 F4 O4 A5 B! P0 W# Z
  8.                 add_filter( 'mce_buttons', 'register_button' );
    * V) l+ _* A) A# n
  9.         }
    ; Q8 s& H: Y2 X% j6 t) K
  10. }
複製代碼
當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。7 Q: b- ]/ e% k: B
最後把函數勾到Wordpress初始化函數
  1. add_action('init', 'my_recent_posts_button');
複製代碼
3 ?& X- u8 Z; j# s3 W$ n% A6 A2 k
4.3 按鈕的用法

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

( Z. J2 \# h: r; X2 C0 N. t
點擊按鈕的時候，會彈出對話框讓我們輸入文章的數量：
/ v$ ?6 ^/ C, E8 j; ~1 d  M
輸入完點擊確定後，會彈出第二個對話框，讓我們輸入列表的標題：
" w5 g& z8 e: G- o
參數留空的話，不會出現在最後的代碼中。最後，短代碼會新加到編輯器中：
( g% Z2 u) C& c# U! L# f
到此就大功告成了。想要增加其他功能的短代碼及按鈕可以參考上面的教學，如法炮製舉一反三，相信可以製作出符合各位需求的短代碼功能。
參考文章: 1 2




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