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

標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕 [打印本頁]
作者: IT_man    時間: 2016-6-9 12:40
標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕
WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
: S( D5 N2 b/ s$ w7 Z9 w* g2 i5 B+ \% v* \* B9 }
wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
, b* {" p9 F$ m) \& ]$ V* v以下是 wordpress 短代碼的詳细介紹及進階應用。
: S# Y, u$ ^4 F2 ^
; U* W$ l6 k+ d$ s+ R' }短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
% O* y8 J" ^$ v1 `( w7 \; E. n, g
  1. [recent-posts]
複製代碼
此外 , 我們可以設定一個參數來控制文章的數量 :& E, ~( }) F4 r8 X7 Y! w2 W- }
  1. [recent-posts posts="5"]
複製代碼
此外 , 我們也可以為文章列表新增一個標題 :$ s1 b7 A. R* p1 E, |7 F" B& D) G
  1. [recent-posts posts="5"]Posts Heading[/recent-posts]
複製代碼
, ^! ?8 ]  e  E# k' U1 V+ \$ J/ n7 u

) l7 G0 \# `' M" d& Q9 X$ k1 \1. 簡單的短代碼
! s5 |. B; s6 L4 F0 f) k本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
# s( [" k6 F2 z( V( r
  1. [recent-posts]
複製代碼
該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
6 [0 i8 T' m' \7 s: h! V
% D& Z7 X7 u) x) p本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。8 r9 c; g+ {4 m8 e8 P
1.1 建立返回函數
2 z+ k( D/ }8 }) w* O; ^當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。$ n# p: C4 O- U, z
  1. function recent_posts_function() {
    & M& k/ M: g0 y1 B. v
  2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
    ' A/ j/ d: y. P7 O
  3.         if (have_posts()) :( E4 g: N7 U. E& f- @, r7 ^3 U
  4.                 while (have_posts()) : the_post();" |. G9 H2 d+ [& r5 e
  5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';& I" ^+ d3 r8 E$ k) v+ i
  6.                 endwhile;
    " X4 ?% X% C- z- Z/ l
  7.         endif;
    9 z! Y. x; h: f4 z) R
  8.         wp_reset_query();% R, T  P1 Y" O" ?" ~" f! S
  9.         return $return_string;2 l9 }) m. u0 e! \" j
  10. }
複製代碼
如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
& l; G9 H( ^/ g: r( s2 _7 C+ A% p
* V0 H( `- H# f% E4 F9 A0 N+ c' C6 `8 i& r* k0 ~1 ]
1.2 註册短代碼
# T6 T4 |: d8 b& E) o3 r. C現在，我們告訴Wordpress這個函數是一個短代碼：
  1. function register_shortcodes(){$ N( t6 [7 v2 D- K" _
  2.         add_shortcode('recent-posts', 'recent_posts_function');
    6 q5 [4 _: ]; C* n/ y% {
  3. }
複製代碼
當在文章的內容中使用短代碼
9 t$ F: r! v7 N$ o3 v
  1. [recent-posts]
複製代碼
將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。, ^& f; X  I3 d
+ e5 F8 q6 v) N0 H
/ J: S* R( B  Q  h. Y
1.3 Hook into WordPress/ C9 c2 Q# H6 P2 j3 C

% O2 H  K6 ^$ C8 ?為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
8 L5 j# K2 T5 X6 b& G' H
  1. add_action( 'init', 'register_shortcodes');
複製代碼
6 }# K% _( z% R& {3 b, z
1.4 測試短代碼2 S+ v3 k. P2 z. H1 A# K& L
簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :
  1. [recent-posts]
複製代碼
2. 進階短代碼
2.1 短代碼参數
短代碼是非常有彈性 , 因為它讓我們加入參數可讓它們有更多的功能。 假設我們必須要顯示某一特定數量的最新的文章。 為了達到這個目的 , 我們需要給短代碼指定其他選項以顯示最近的文章數。
我們需要使用兩個函數 ,第一個是內建在 wordpress 的shortcode _ atts ( ) 函式 , 它把用戶的短代碼屬性與本地屬性結合在一起 , 並填入到想要的位置。 第二個是 PHP的extract() 函数 , 顧名思義 , 它萃取出短代碼中的各個屬性。
展開我們的返回功能 , 我們新增一個參數 $atts, 它是一個陣列,從中可以提取到我們需要的文章數。 我們查詢資料庫來取得指定數目的文章 , 並傳回一個列表 :
  1. function recent_posts_function($atts){
    ! C' _$ i0 D, M, q- F! c+ A1 m
  2.         extract(shortcode_atts(array(
    # w/ _! p9 O6 \7 r9 [$ _
  3.                 'posts' => 1,/ K- j' l4 c7 Q$ {
  4.         ), $atts));
    : n% V6 k4 K0 ]3 K
  5. ; q$ u# F3 ^% m4 v4 t( r
  6.         $return_string = '<ul>';- i- Y, q8 b  @) e) n' f
  7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));7 W+ V7 J" y  d3 G. q( ]
  8.         if (have_posts()) :
    $ G5 g6 D: D* U+ P( e
  9.                 while (have_posts()) : the_post();
    ) C" y# ?8 ]7 h, M+ R2 t. M
  10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';( u7 q7 r( S/ j! E) G
  11.                 endwhile;
    ' \6 U! {. B8 {) ?. a
  12.         endif;4 y0 h: L! M3 O4 z% v
  13.         $return_string .= '</ul>';2 X' @/ s; |. H: e) R

  14. ; U8 u( X+ q! y
  15.         wp_reset_query();: G6 l3 [$ k, f+ i& x' R/ E7 Z
  16.         return $return_string;7 h6 |  Z1 Y. j) M0 p
  17. }
複製代碼
如果使用者未指定此選項 , 1 將是預設值。 我們可以加入多個屬性使短代碼接受更多的參數。 使用這項強化函數 , 我們就可以指定調用最新文章的數量 :
  1. [recent-posts posts="5"]
複製代碼
當顯示於瀏覽器 , 您就可以看到最近的五篇文章列表
. F- Q: @* z$ [& \; M$ Z. Q
2.2 短代碼中增加内容
我們可以繼續擴展我們的短代碼、新增一些內容作為參數 來傳遞, 例如"最新文章列表的標題"。 若要達成此目的 , 我們需要在返回函數中新增第二個參數$content , 並把它顯示在列表前面的一個 <h3> 標簽中。新的函數如下：
  1. function recent_posts_function($atts, $content = null) {" x+ f3 c' m8 i2 S! W
  2.         extract(shortcode_atts(array(+ a0 _) c6 z1 K2 Y  D5 C2 R6 A
  3.                 'posts' => 1,' w) h$ l/ c( b8 M6 V' M
  4.         ), $atts));* o2 V$ M! ]9 z. u/ J

  5. , M9 A3 Y" D$ G- I
  6.         $return_string = '<h3>'.$content.'</h3>';
    ; e9 b. S- d+ Y8 p4 L* S
  7.         $return_string .= '<ul>';
    ! _3 _1 B1 Y# u4 Z% V6 A
  8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));5 Y+ R$ ], `; F4 a
  9.         if (have_posts()) :
    5 w& ], s/ k8 ?# G. r
  10.                 while (have_posts()) : the_post();
    * ?% }% [' h9 Z& d
  11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';) F2 [. @1 _$ T0 O. G7 T4 }
  12.                 endwhile;
    & N6 }. E" ^+ u0 G
  13.         endif;0 o' R. A, V/ h+ K
  14.         $return_string .= '</ul>';
    9 e4 P+ S0 W" Y9 [( i5 P

  15. 4 B  d: x# t1 r, y
  16.         wp_reset_query();
    ' _6 j9 W8 |+ f! y9 c" n
  17.         return $return_string;
    - ^& q: O, E# t
  18. }
複製代碼
這種短代碼類似於一個HTML標簽：
  1. [recent-posts posts="5"]This is the list heading[/recent-posts]
複製代碼
除了文章列表多了一個標題，其餘的內容和上一個示例是一樣的：

* o/ \0 D( e4 h( A0 h+ c5 k; X
3. 在任何地方顯示短代碼
3.1 在側邊攔小工具中使用短代碼
預設情況下 , 側邊欄小工具是忽略短代碼的，您可以將此程式碼放在小工具
. Y; l$ h  n! v0 U) S7 {: z( y
我們可以採用一行程式碼來啟用這個函數 , 為了使側邊欄小工具支援短代碼 , 新增以下的程式碼 :
  1. add_filter('widget_text', 'do_shortcode');
複製代碼
現在不需要修改任何其他地方 , 刷新頁面, 側邊欄將會正確地顯示
, ]) O3 J/ M" \* w( s: c
同樣的，在評論中啟用短代碼：
  1. add_filter( 'comment_text', 'do_shortcode' );
複製代碼
在摘要中啟用短代碼：
  1. add_filter( 'the_excerpt', 'do_shortcode');
複製代碼
4. TinyMCE編輯器增加短代碼按鈕; D' J; z: }  C) ?# G0 V, l) w

  x5 G3 B9 ?4 m3 S. q" g" W雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。
要解決這個，我們可以給 TinyMCE編輯器增加一個按鈕，使用戶可以透過簡單的點擊來增加短代碼。建立這個按鈕僅需兩個步驟：
# |; U  l& {+ j6 P
4.1 透過JS文件來建立按鈕
JS文件是透過 TinyMCE API 來註冊 TinyMCE 插件的。我們在主題的 js 目錄下(/wp-content/themes/你主題名稱/js/)建立 recent-posts.js ，並貼進去下面的代碼（需要把按鈕圖片檔(/wp-content/themes/你主題名稱/js/recentpostsbutton.png)也放在同一個目錄）：
  1. (function() {) b& Z+ b6 u9 u: e$ v; N8 G
  2.         tinymce.create('tinymce.plugins.recentposts', {
    4 N; F" h+ q) K$ }4 }$ P
  3.                 init : function(ed, url) {
    + B5 c1 K3 e% Z  a3 b# C) C
  4.                         ed.addButton('recentposts', {) A6 S) H2 y* r1 `% p- Y
  5.                                 title : 'Recent posts',
      X1 A- c/ y% K
  6.                                 image : url+'/recentpostsbutton.png',2 ]( w; x4 N  [) I5 x( A
  7.                                 onclick : function() {
    " L5 F; Z  u- G3 M
  8.                                         var posts = prompt("文章數量", "1");
    : O1 n* E9 S. b1 G2 U
  9.                                         var text = prompt("請填入列表標題", "最新文章");0 C$ W9 c' l; D2 B; ~0 l& p

  10. 8 O3 k! f1 l0 W) P7 c' T* o
  11.                                         if (text != null && text != ''){) k; H0 d  J# a4 Y  o/ [4 t/ O
  12.                                                 if (posts != null && posts != '')$ V' J/ k# A" e0 u& |
  13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    ) H6 R8 c5 f+ ~2 W3 x" e( g" P8 M
  14.                                         else8 w7 a/ Z0 W$ y& M5 o
  15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');, x! P7 y: U1 _9 x5 V
  16.                                         }; ~4 f6 r# g: e: C) O4 S8 Y
  17.                                         else{
    ) e0 z7 f) |7 ^7 [
  18.                                                 if (posts != null && posts != '')
    $ ~. n% I: e/ Z& t1 b
  19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');' T& I, y7 ^& W( D; z2 ]0 t
  20.                                                 else. @( y7 ]. b4 E, h3 G$ {  m9 e
  21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');. c% h- _/ r: M4 d! f/ }
  22.                                         }
    ( h! n7 H3 N, S' t
  23.                                 }9 _! F6 a* I, E( k% L; ?5 j( e
  24.                         });, Y1 A- _* V' \/ ^4 F& x
  25.                 },
    / b8 P7 }5 c- a' I
  26.                 createControl : function(n, cm) {; w2 g4 Z: F/ Y. t: e9 v  J
  27.                         return null;- C$ o4 h( s7 q
  28.                 },
    ' c2 L8 c- y; T7 f) G7 z
  29.                 getInfo : function() {
    6 B; V, [7 r( G/ v1 M# f! |  L
  30.                         return {
    ! D6 S  U# E% G2 P
  31.                                 longname : "Recent Posts",
    , F7 r) {; l; i& J/ g
  32.                                 author : 'Specs',
    + F& M- z, R. e0 J# p
  33.                                 authorurl : 'http://9iphp.com',
    ( d2 y) J* p, C, @, k
  34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    5 ^  m. f* K- D$ E8 h- d7 l
  35.                                 version : "1.0"' J7 ^) v6 i) [, u5 S
  36.                         };7 ?( s) [; J! f2 V! j% f% o
  37.                 }
    ; K8 z; I0 g, }6 V# X
  38.         });% q* V4 s' z2 Y9 \- T7 l
  39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);- J6 v! c  q1 y) x4 r
  40. })();
複製代碼
我們透過呼叫 tinymce.create() 建立了一個插件。代碼中最重要的是 init() 函數，我們定義了一個名字，一個icon文件及 onclick() 事件處理程序。
在 onclick() 函數的前兩行，依序彈出兩個對話框讓用戶輸入文章數量及列表標題兩個參數，然後根據用戶輸入，把短代碼插入到編輯器中。
最後，TinyMCE插件透過 add() 函數增加到 PluginManager。現在我們已經成功的整合了 [recent-posts] 短代碼到Wordpress中。

, |& [$ q8 X8 A: v$ P* Z$ t
4.2 註冊按鈕及TinyMCE插件8 }, V* `; s$ O) N$ x$ S6 f

0 Q$ f2 k6 T+ `/ [* |. V
當您完成建立的JS 檔 , 我們現在需要註冊它和短代碼按鈕。 因此我們建立了兩個函數並把它們繫結至適當的 wordpress 過濾器中。
第一個叫做 register_button() 的函數把短代碼增加到按鈕陣列中，在現有按鈕和新按鈕之間增加分割線。
  1. function register_button( $buttons ) {8 ]5 V' Y6 v2 ~9 a. @3 P
  2.         array_push( $buttons, "|", "recentposts" );
      O2 \  ~! X+ {4 u. b8 }+ ]6 n
  3.         return $buttons;
    # q5 w, J9 B* V& e# |
  4. }
複製代碼
第二個函數 add_plugin() 指定JS文件的路徑及文件名。
) r( P+ y8 ^1 ^( y* U
  1. function add_plugin( $plugin_array ) {$ n6 y# P9 }: |( @1 R  O# L
  2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';# B0 i& G) Y* K) Y
  3.         return $plugin_array;
    9 g' J# ^8 i3 J$ s- B: k1 _
  4. }
複製代碼
下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。
5 u2 @' L2 v: S( D0 V* T9 M" D  X
  1. function my_recent_posts_button() { ; B3 ~. M1 ?4 p8 \
  2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {# g- L% y7 G9 G, e2 Q! V
  3.                 return;
    & z2 v) \8 R+ q" Q# e% N
  4.         }
    ' M8 i2 V/ y- V% l/ s
  5. % X4 I( Q8 _1 J. n% \/ n4 @
  6.         if ( get_user_option('rich_editing') == 'true' ) {; s: I/ `4 j, R5 O! i$ c! z( i/ G4 Y# G$ d
  7.                 add_filter( 'mce_external_plugins', 'add_plugin' );+ d. F' H% z- P4 [1 N
  8.                 add_filter( 'mce_buttons', 'register_button' );
    4 L. c; I6 E' v  Y- K/ n
  9.         }
    6 `6 A2 l+ v3 ]* w
  10. }
複製代碼
當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。9 u8 W9 C0 G$ }- K
最後把函數勾到Wordpress初始化函數
  1. add_action('init', 'my_recent_posts_button');
複製代碼

9 C4 D6 r# ]  S* q7 l4.3 按鈕的用法
! Z9 Y9 Y/ u6 ]7 q0 l
為了測試程式碼是否正確，我們打開一篇新的文章，這時一個我們剛剛定義的按鈕是不是已經出現在第一行的末尾了？如下圖所示：
7 m$ `* O' F6 d
點擊按鈕的時候，會彈出對話框讓我們輸入文章的數量：

. h4 j* x: n% S8 q# E
輸入完點擊確定後，會彈出第二個對話框，讓我們輸入列表的標題：
& c5 C8 y) C  M" [8 L& {
參數留空的話，不會出現在最後的代碼中。最後，短代碼會新加到編輯器中：

" F! i7 u* J$ l) p
到此就大功告成了。想要增加其他功能的短代碼及按鈕可以參考上面的教學，如法炮製舉一反三，相信可以製作出符合各位需求的短代碼功能。
參考文章: 1 2




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