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

標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕 [打印本頁]
作者: IT_man    時間: 2016-6-9 12:40
標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕
WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
+ f% ?" l9 z" s" |
- B' d: @2 f1 w0 Nwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。* I( M- l/ D/ |1 n: B$ t
以下是 wordpress 短代碼的詳细介紹及進階應用。! {- W6 a: D6 D$ Z; j/ [' V$ R3 m
% k8 O: d9 N+ w+ D5 L
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
. L: b$ M1 \& `" n/ ]' y7 [
  1. [recent-posts]
複製代碼
此外 , 我們可以設定一個參數來控制文章的數量 :
! G! Z4 t" f1 G. ^. V, i
  1. [recent-posts posts="5"]
複製代碼
此外 , 我們也可以為文章列表新增一個標題 :5 [, e) ~, t( q, T3 f4 i  R
  1. [recent-posts posts="5"]Posts Heading[/recent-posts]
複製代碼

% T6 b6 c) q7 A$ }# I$ C' Q% Y( C9 L! T5 _# m: q( T# y
1. 簡單的短代碼4 C/ `7 W' x7 I) E& y
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :) Y, }3 G8 H' l* I" d
  1. [recent-posts]
複製代碼
該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
* G0 P5 F/ F$ \1 Q8 J
4 Q0 `1 w  _, ^9 F2 h6 M" f- G本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
$ f/ `% [! c$ |9 v; P3 Z+ \  F% G+ e# v1.1 建立返回函數
/ X* o1 f1 B+ T當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。' w; h* D( E: V) B( ]
  1. function recent_posts_function() {
    & Q) }1 n$ ~) \/ L, G
  2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));, k' o% X9 N; \0 t2 o/ y0 T6 P
  3.         if (have_posts()) :4 @/ C' A$ F* t. x
  4.                 while (have_posts()) : the_post();# ^3 D/ i6 h: f2 g" o
  5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
    " p4 X' z9 A1 g& Z. r9 I' W
  6.                 endwhile;
    / {' y- S0 K5 M. q# d# T
  7.         endif;7 X% p4 l( j, g3 D& `
  8.         wp_reset_query();
    4 U3 n; D8 X" r( s) I
  9.         return $return_string;
    3 d2 ?/ l7 }# j* t( q
  10. }
複製代碼
如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
4 D( C5 |8 S2 k
8 z6 N# v' x$ V. \8 x9 @
1 M) l9 o; Z/ Z% f/ |: [' `$ a& g1.2 註册短代碼2 A$ |; i. @) S' }* d
現在，我們告訴Wordpress這個函數是一個短代碼：
  1. function register_shortcodes(){& c& S+ N2 K- m9 D+ f, y' [
  2.         add_shortcode('recent-posts', 'recent_posts_function');. `# }; r; d) F/ u, s
  3. }
複製代碼
當在文章的內容中使用短代碼
4 [/ T: m9 j& d
  1. [recent-posts]
複製代碼
將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。" W; O# U% q: n# D7 m

) E+ N: ^2 d2 K% r: Q! s2 `8 r5 e0 f
1.3 Hook into WordPress
6 W" Y" b6 H2 j0 Z8 Q3 P) a$ S. {) t: o3 v9 D
為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。) |  ]* P- t5 V0 e  t8 X( d
  1. add_action( 'init', 'register_shortcodes');
複製代碼
; H, |/ E7 s% r( \2 W
1.4 測試短代碼
1 C4 E7 n8 \4 s) J簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :
  1. [recent-posts]
複製代碼
2. 進階短代碼
2.1 短代碼参數
短代碼是非常有彈性 , 因為它讓我們加入參數可讓它們有更多的功能。 假設我們必須要顯示某一特定數量的最新的文章。 為了達到這個目的 , 我們需要給短代碼指定其他選項以顯示最近的文章數。
我們需要使用兩個函數 ,第一個是內建在 wordpress 的shortcode _ atts ( ) 函式 , 它把用戶的短代碼屬性與本地屬性結合在一起 , 並填入到想要的位置。 第二個是 PHP的extract() 函数 , 顧名思義 , 它萃取出短代碼中的各個屬性。
展開我們的返回功能 , 我們新增一個參數 $atts, 它是一個陣列,從中可以提取到我們需要的文章數。 我們查詢資料庫來取得指定數目的文章 , 並傳回一個列表 :
  1. function recent_posts_function($atts){2 j: n: m; o8 Z$ I; _9 }
  2.         extract(shortcode_atts(array(! g& ~2 a' ], l) D; F+ ~8 g
  3.                 'posts' => 1,
    ' r4 s+ q, e2 P$ Y6 o, n
  4.         ), $atts));' O  o' Q; Z8 ~  D

  5. 5 u- z7 Z5 _8 _& [
  6.         $return_string = '<ul>';' l, Q$ z: o0 j8 _1 n- X% H
  7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
    ! k& ]3 d: y# `. T8 F' i; D1 T; w
  8.         if (have_posts()) :* N0 G- {: ?7 w: g
  9.                 while (have_posts()) : the_post();6 ?- l2 x6 v; u. S+ ^9 Y9 G
  10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';3 u7 u1 S/ r' x1 Y$ N0 I' S- Z
  11.                 endwhile;
    ; z" Y3 P* |5 b4 k% Y3 d
  12.         endif;
    2 L5 V, ?5 U$ Y0 r8 R
  13.         $return_string .= '</ul>';% K; d. L# z" _8 v7 R6 M7 U
  14. 0 T' _, c2 U% F. {
  15.         wp_reset_query();  |, H7 v0 a0 w6 E( l0 g' M3 {; @% o
  16.         return $return_string;
    ! r& P* T- ?+ n) C7 P" E
  17. }
複製代碼
如果使用者未指定此選項 , 1 將是預設值。 我們可以加入多個屬性使短代碼接受更多的參數。 使用這項強化函數 , 我們就可以指定調用最新文章的數量 :
  1. [recent-posts posts="5"]
複製代碼
當顯示於瀏覽器 , 您就可以看到最近的五篇文章列表
; p! I3 i' K) j
2.2 短代碼中增加内容
我們可以繼續擴展我們的短代碼、新增一些內容作為參數 來傳遞, 例如"最新文章列表的標題"。 若要達成此目的 , 我們需要在返回函數中新增第二個參數$content , 並把它顯示在列表前面的一個 <h3> 標簽中。新的函數如下：
  1. function recent_posts_function($atts, $content = null) {
    / p% e' o9 n5 n. q+ v
  2.         extract(shortcode_atts(array(6 |: N) P( s. W& q) F1 U, ~
  3.                 'posts' => 1,
    8 \+ O+ M( S& U) X/ J9 j/ S
  4.         ), $atts));
    4 Q8 K/ O5 {4 x/ D' D/ |

  5. 1 c* W5 Z8 ?3 l2 I5 T7 @
  6.         $return_string = '<h3>'.$content.'</h3>';' ^! U# U- y( o: B6 w, {
  7.         $return_string .= '<ul>';
    5 L& S6 M+ E- _! y1 L1 q# ]2 @
  8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));4 f0 s) q, R% c7 z$ K
  9.         if (have_posts()) :
    8 ?& n% c/ I& [
  10.                 while (have_posts()) : the_post();
    ) p) T- f1 o+ M' w
  11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';8 N# k: E2 g; W' g) ]7 A
  12.                 endwhile;4 v5 k* a: L- ]5 Q: R; l
  13.         endif;
    7 A4 }* _0 a+ s5 n6 ^3 p
  14.         $return_string .= '</ul>';
    1 C$ a3 A3 M# A. U# H* Y

  15. # B3 l6 ]* S3 p8 o) m( Y
  16.         wp_reset_query();. ~& Y4 S5 D; h7 z& M
  17.         return $return_string;1 a- {8 k1 q( v0 k" Z
  18. }
複製代碼
這種短代碼類似於一個HTML標簽：
  1. [recent-posts posts="5"]This is the list heading[/recent-posts]
複製代碼
除了文章列表多了一個標題，其餘的內容和上一個示例是一樣的：

, d0 x% [7 [2 n
3. 在任何地方顯示短代碼
3.1 在側邊攔小工具中使用短代碼
預設情況下 , 側邊欄小工具是忽略短代碼的，您可以將此程式碼放在小工具

5 B' I. _! ~4 H! }+ V+ r
我們可以採用一行程式碼來啟用這個函數 , 為了使側邊欄小工具支援短代碼 , 新增以下的程式碼 :
  1. add_filter('widget_text', 'do_shortcode');
複製代碼
現在不需要修改任何其他地方 , 刷新頁面, 側邊欄將會正確地顯示
* X- Z4 X. O( O% @
同樣的，在評論中啟用短代碼：
  1. add_filter( 'comment_text', 'do_shortcode' );
複製代碼
在摘要中啟用短代碼：
  1. add_filter( 'the_excerpt', 'do_shortcode');
複製代碼
4. TinyMCE編輯器增加短代碼按鈕
" K# V9 _% @0 g0 `2 K" h  g9 N% Q! a7 a0 |0 l8 {
雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。
要解決這個，我們可以給 TinyMCE編輯器增加一個按鈕，使用戶可以透過簡單的點擊來增加短代碼。建立這個按鈕僅需兩個步驟：
: S) ?& u- A) y# \8 g
4.1 透過JS文件來建立按鈕
JS文件是透過 TinyMCE API 來註冊 TinyMCE 插件的。我們在主題的 js 目錄下(/wp-content/themes/你主題名稱/js/)建立 recent-posts.js ，並貼進去下面的代碼（需要把按鈕圖片檔(/wp-content/themes/你主題名稱/js/recentpostsbutton.png)也放在同一個目錄）：
  1. (function() {
    + O& d; z7 j; |8 J
  2.         tinymce.create('tinymce.plugins.recentposts', {% @7 m6 c$ ?4 }, j8 M0 L& I
  3.                 init : function(ed, url) {# @' a* D7 H% p4 z) E  q6 v
  4.                         ed.addButton('recentposts', {2 _8 r0 \1 `4 }6 x& k) u
  5.                                 title : 'Recent posts',
    7 ^( J, N: h: l- i% o4 E
  6.                                 image : url+'/recentpostsbutton.png',
    ! L4 }2 f, T$ H3 P+ M. o( B
  7.                                 onclick : function() {
    5 R- t5 R( {+ U+ |0 N: Z1 @  ~
  8.                                         var posts = prompt("文章數量", "1");% P( q$ W5 \* M5 R- J
  9.                                         var text = prompt("請填入列表標題", "最新文章");" r0 M. m. Y4 d2 ?& C
  10. 0 {4 j2 P7 `$ c# Y/ C8 q
  11.                                         if (text != null && text != ''){
    . l- B' p8 A  {7 [$ w. w: T
  12.                                                 if (posts != null && posts != '')/ k2 O9 ?; ]2 ~4 z+ ^* s
  13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');7 _8 Q( G. R: m7 k; m
  14.                                         else1 g4 A  v1 e( \# G- L! Z
  15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    9 B/ h( i2 |5 m- d. s. J3 N
  16.                                         }& }8 d0 R& w0 `/ P
  17.                                         else{
    $ }; n9 Q8 C3 s5 S1 V# q% x
  18.                                                 if (posts != null && posts != '')
    4 V$ \) r9 {0 i2 K
  19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');" `4 ^0 N8 D+ m, Y
  20.                                                 else+ j- \1 O' I) K0 g5 k5 X7 q
  21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');3 L! I$ N* }( L7 T
  22.                                         }: v8 ^) f  D9 ~# l0 r
  23.                                 }
    6 G* ?" G: Y' d! A4 M/ c( j: j4 Q, f
  24.                         });/ {' k! \! M/ @
  25.                 },
    8 D0 {: z: W) k* b6 f2 }, `
  26.                 createControl : function(n, cm) {0 {  D+ P) W1 f
  27.                         return null;
    9 X; D, O: o8 q& c' a
  28.                 },
    # |& t( T( ^6 [/ J( g7 q
  29.                 getInfo : function() {
    4 _$ I, {) M3 e
  30.                         return {3 Z% z3 E3 t. F. ~
  31.                                 longname : "Recent Posts",
    : Q, H( I! _2 s& x
  32.                                 author : 'Specs',
    + |0 a5 F, u' @1 V; _8 r  e
  33.                                 authorurl : 'http://9iphp.com',
    : g+ i+ v- Q2 L' e
  34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',3 y- J; Y6 t* R0 Y
  35.                                 version : "1.0"5 u8 X9 ^+ N' G) K% ~
  36.                         };! i4 J5 Q# h& {2 G7 O
  37.                 }, P' Z; R8 W# q# S9 D
  38.         });
    . H# [& K& o* z# A5 V# {& X
  39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);# {- p2 k" e1 S  V) c5 n' [  W  ?; i
  40. })();
複製代碼
我們透過呼叫 tinymce.create() 建立了一個插件。代碼中最重要的是 init() 函數，我們定義了一個名字，一個icon文件及 onclick() 事件處理程序。
在 onclick() 函數的前兩行，依序彈出兩個對話框讓用戶輸入文章數量及列表標題兩個參數，然後根據用戶輸入，把短代碼插入到編輯器中。
最後，TinyMCE插件透過 add() 函數增加到 PluginManager。現在我們已經成功的整合了 [recent-posts] 短代碼到Wordpress中。

1 z9 N# W+ @, E4 `4 Z, R" c& i
4.2 註冊按鈕及TinyMCE插件  A! Z$ g% x7 w7 O3 x
, i$ N3 R8 _3 N! J2 L+ U
當您完成建立的JS 檔 , 我們現在需要註冊它和短代碼按鈕。 因此我們建立了兩個函數並把它們繫結至適當的 wordpress 過濾器中。
第一個叫做 register_button() 的函數把短代碼增加到按鈕陣列中，在現有按鈕和新按鈕之間增加分割線。
  1. function register_button( $buttons ) {
    7 m6 Z7 q+ G( s7 s; v2 E0 G$ r
  2.         array_push( $buttons, "|", "recentposts" );
    $ Z- n! z2 \. e) Y4 o2 J
  3.         return $buttons;
    - }& [6 ]% r8 Q8 Z4 B2 H! ]3 [
  4. }
複製代碼
第二個函數 add_plugin() 指定JS文件的路徑及文件名。. ^% s1 m0 e2 d$ A) w
  1. function add_plugin( $plugin_array ) {0 e/ X7 ?/ C0 n. W
  2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';4 I  X5 u% d4 }
  3.         return $plugin_array;
    $ P3 l4 L8 I$ S" P+ T
  4. }
複製代碼
下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。/ @5 n1 q8 z/ _: d, l6 K
  1. function my_recent_posts_button() {
    4 l. w% D% l4 d7 p
  2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
    - [7 Q  s, Q. |4 K# J$ l& k0 Z
  3.                 return;. y9 A5 k! i7 e$ D. @
  4.         }  t/ k* w2 M& q, O4 }9 \/ Y& J

  5. . b# |( I" Q. V1 K/ M
  6.         if ( get_user_option('rich_editing') == 'true' ) {
    & k9 e, E  K4 b
  7.                 add_filter( 'mce_external_plugins', 'add_plugin' );4 M- F, f; L! S: p% `
  8.                 add_filter( 'mce_buttons', 'register_button' );+ K; v1 t  k3 E
  9.         } ( m" ?4 L- _3 |* O% J
  10. }
複製代碼
當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。# D1 n0 H% u3 Z" [7 X2 P1 E
最後把函數勾到Wordpress初始化函數
  1. add_action('init', 'my_recent_posts_button');
複製代碼
5 y' h' Q% y7 F0 ]/ b* r  c2 s
4.3 按鈕的用法
1 a( |1 G7 ^% M+ d
為了測試程式碼是否正確，我們打開一篇新的文章，這時一個我們剛剛定義的按鈕是不是已經出現在第一行的末尾了？如下圖所示：
9 }- W, n3 i" e$ }: \* x( Y1 C
點擊按鈕的時候，會彈出對話框讓我們輸入文章的數量：

8 w$ {5 i5 F, M/ G3 Q
輸入完點擊確定後，會彈出第二個對話框，讓我們輸入列表的標題：

. J7 @1 g( b- R
參數留空的話，不會出現在最後的代碼中。最後，短代碼會新加到編輯器中：

: p1 M) Z) m; _( F: |; e
到此就大功告成了。想要增加其他功能的短代碼及按鈕可以參考上面的教學，如法炮製舉一反三，相信可以製作出符合各位需求的短代碼功能。
參考文章: 1 2




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