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

標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕 [打印本頁]
作者: IT_man    時間: 2016-6-9 12:40
標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕
WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)* C, j, ~& {: |6 D  A& F( @8 c/ d
# ?, k9 N3 F7 h1 \2 c/ y. W8 [
wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。% |' p" h$ R/ g& i1 y6 ?1 Q  L
以下是 wordpress 短代碼的詳细介紹及進階應用。
3 A7 @/ ?5 M# f$ v  ]% ^! T
- {+ A( T% ^; |4 Y% |  ~  b短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
- y0 F+ i( w6 O! M/ g; h5 `
  1. [recent-posts]
複製代碼
此外 , 我們可以設定一個參數來控制文章的數量 :
7 W# l4 b2 t9 Z: ~1 t  K
  1. [recent-posts posts="5"]
複製代碼
此外 , 我們也可以為文章列表新增一個標題 :
& b/ V% L' q7 w" y0 I0 J
  1. [recent-posts posts="5"]Posts Heading[/recent-posts]
複製代碼
1 V! v- V* x) o& V- X

% g( }+ j8 G! N( d' t1. 簡單的短代碼) M9 p+ g; @9 k0 m/ {' L
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :* B! k4 ]# r( U) R
  1. [recent-posts]
複製代碼
該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :* c& i9 _4 d8 A4 q& F
5 X, v' O8 c6 v8 O) e3 D- D
本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
' G8 u4 \* `; I# R: I; Z( f1.1 建立返回函數
3 M5 |# M: G5 P% a6 _! Z當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。7 p7 |* R! r: f( e% C" Y( ?
  1. function recent_posts_function() {4 `1 Z7 |8 ]/ `9 c" R
  2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));* J9 l. W. [! i: l9 {+ W
  3.         if (have_posts()) :0 b( {/ U% @8 `+ U/ d
  4.                 while (have_posts()) : the_post();. ]& H" F9 d! B
  5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
    $ W9 `5 L1 T2 K; i5 z
  6.                 endwhile;
    9 {; Y  H7 A' y6 B
  7.         endif;0 B6 s- Y. n0 `; N8 x2 S
  8.         wp_reset_query();
    6 e( g; M0 d" d" k- {9 j' x, s
  9.         return $return_string;
    9 \2 Y! m( |. ]; Z4 ?4 A
  10. }
複製代碼
如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。
; C" ~; Z: J& Y1 K5 ~3 J' ]) X+ @# w* E; e# i' {5 U

( Y. L  ^0 A* U* @2 {& R0 ]1.2 註册短代碼
7 W4 B' n  ~& C9 u9 z; Y3 [& n現在，我們告訴Wordpress這個函數是一個短代碼：
  1. function register_shortcodes(){( Z/ S0 r/ @! W4 A( d4 w$ S
  2.         add_shortcode('recent-posts', 'recent_posts_function');
    2 T% [( p& v/ N! a
  3. }
複製代碼
當在文章的內容中使用短代碼! O* T' R  ~$ S
  1. [recent-posts]
複製代碼
將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。( V6 R- C$ @- _% s

; H# K  ?9 N; r* g7 z
( A# s/ X8 Q3 C5 j1.3 Hook into WordPress: Z9 G+ F$ B! }- I. A2 k
; h3 \  E$ K6 G. a3 d' j
為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。+ N" }+ y; p* o, H0 d
  1. add_action( 'init', 'register_shortcodes');
複製代碼
' k% }" r2 ^# R4 H  X
1.4 測試短代碼. C0 y' q: C& ~9 y( h9 E. @" G% ]7 H
簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :
  1. [recent-posts]
複製代碼
2. 進階短代碼
2.1 短代碼参數
短代碼是非常有彈性 , 因為它讓我們加入參數可讓它們有更多的功能。 假設我們必須要顯示某一特定數量的最新的文章。 為了達到這個目的 , 我們需要給短代碼指定其他選項以顯示最近的文章數。
我們需要使用兩個函數 ,第一個是內建在 wordpress 的shortcode _ atts ( ) 函式 , 它把用戶的短代碼屬性與本地屬性結合在一起 , 並填入到想要的位置。 第二個是 PHP的extract() 函数 , 顧名思義 , 它萃取出短代碼中的各個屬性。
展開我們的返回功能 , 我們新增一個參數 $atts, 它是一個陣列,從中可以提取到我們需要的文章數。 我們查詢資料庫來取得指定數目的文章 , 並傳回一個列表 :
  1. function recent_posts_function($atts){
    & X  C7 u- z+ A2 S/ N& z, w1 S: K
  2.         extract(shortcode_atts(array(
    ' D0 j* q* t1 z3 I8 d2 T4 v
  3.                 'posts' => 1," L9 I" w. O3 e5 r
  4.         ), $atts));
    ( i7 C7 W( A$ b& H/ a9 s4 n' Y  m0 c
  5. / Q' _! {! g) t# E6 B( X5 _0 W
  6.         $return_string = '<ul>';4 {2 U# J" T5 G% L& j1 @6 ~' P3 j4 Y
  7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
    * r4 c# V. n- ~! a
  8.         if (have_posts()) :
    + z$ ^  _( u3 t! n) u: h" M
  9.                 while (have_posts()) : the_post();
    & n, h; K& p  t* p9 Z# h, W
  10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    " `1 ^0 O0 \5 s- H6 Z
  11.                 endwhile;
    8 ~2 I+ h5 c2 i
  12.         endif;" f- f$ g  g9 @3 ?8 z% W
  13.         $return_string .= '</ul>';
    : p7 t& w9 S- ~0 H7 V

  14. , U* ~4 Q. u( x
  15.         wp_reset_query();# n4 B7 m2 O  |8 f' I/ ]8 \0 c
  16.         return $return_string;6 A% S- }" O0 E- F
  17. }
複製代碼
如果使用者未指定此選項 , 1 將是預設值。 我們可以加入多個屬性使短代碼接受更多的參數。 使用這項強化函數 , 我們就可以指定調用最新文章的數量 :
  1. [recent-posts posts="5"]
複製代碼
當顯示於瀏覽器 , 您就可以看到最近的五篇文章列表

* P+ k( v# l0 Y2.2 短代碼中增加内容
我們可以繼續擴展我們的短代碼、新增一些內容作為參數 來傳遞, 例如"最新文章列表的標題"。 若要達成此目的 , 我們需要在返回函數中新增第二個參數$content , 並把它顯示在列表前面的一個 <h3> 標簽中。新的函數如下：
  1. function recent_posts_function($atts, $content = null) {& z5 A, o8 B% S" L6 u8 w1 t
  2.         extract(shortcode_atts(array(9 H* @0 k4 X, ?( i
  3.                 'posts' => 1,# V8 S7 ^$ H. e% J$ }
  4.         ), $atts));7 E* R: {8 I: K  \: k- {

  5. : U/ s2 I/ n% U  v+ a+ ?* p: }
  6.         $return_string = '<h3>'.$content.'</h3>';
    / {/ X; P' a" @( ~$ I; y
  7.         $return_string .= '<ul>';
    5 t( c+ _; w/ P- A! t, o( {9 L! {2 F
  8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
    : l8 @) j4 M# h( Q' C) ?0 d
  9.         if (have_posts()) :
    8 t$ @/ {/ \" V+ s
  10.                 while (have_posts()) : the_post();' ]8 D7 G8 {5 {) z# g
  11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';$ O- i3 a1 \' L0 A
  12.                 endwhile;8 X& ?# h$ v6 ^$ K( ]: A0 C
  13.         endif;
    / A' y3 O* j# l3 ~- r  _% y
  14.         $return_string .= '</ul>';
    , p  B6 d, b8 B3 q; ]6 \* P5 u

  15. # X# s$ d8 [6 m% [+ V& x. ]' f
  16.         wp_reset_query();+ C9 ]0 o: T/ h# F
  17.         return $return_string;1 L' `1 A3 x, A  }+ ]1 S& C# {4 X
  18. }
複製代碼
這種短代碼類似於一個HTML標簽：
  1. [recent-posts posts="5"]This is the list heading[/recent-posts]
複製代碼
除了文章列表多了一個標題，其餘的內容和上一個示例是一樣的：
- g. c- F2 D) y+ ?
3. 在任何地方顯示短代碼
3.1 在側邊攔小工具中使用短代碼
預設情況下 , 側邊欄小工具是忽略短代碼的，您可以將此程式碼放在小工具

0 F' F( L" ?3 v% X& [& e- {
我們可以採用一行程式碼來啟用這個函數 , 為了使側邊欄小工具支援短代碼 , 新增以下的程式碼 :
  1. add_filter('widget_text', 'do_shortcode');
複製代碼
現在不需要修改任何其他地方 , 刷新頁面, 側邊欄將會正確地顯示
$ v$ \- L9 ?# A+ R) e* x
同樣的，在評論中啟用短代碼：
  1. add_filter( 'comment_text', 'do_shortcode' );
複製代碼
在摘要中啟用短代碼：
  1. add_filter( 'the_excerpt', 'do_shortcode');
複製代碼
4. TinyMCE編輯器增加短代碼按鈕5 j9 L, e! X& X
/ p  M" C8 Y% a7 O
雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。
要解決這個，我們可以給 TinyMCE編輯器增加一個按鈕，使用戶可以透過簡單的點擊來增加短代碼。建立這個按鈕僅需兩個步驟：

4 j8 B! C# m! A. [% _( ]- j4.1 透過JS文件來建立按鈕
JS文件是透過 TinyMCE API 來註冊 TinyMCE 插件的。我們在主題的 js 目錄下(/wp-content/themes/你主題名稱/js/)建立 recent-posts.js ，並貼進去下面的代碼（需要把按鈕圖片檔(/wp-content/themes/你主題名稱/js/recentpostsbutton.png)也放在同一個目錄）：
  1. (function() {/ p9 d5 I3 H" o! \; x5 b
  2.         tinymce.create('tinymce.plugins.recentposts', {
    - V  @9 W1 o$ D% G- M5 l6 x0 m
  3.                 init : function(ed, url) {$ d* V- M) s* z$ f5 T" B
  4.                         ed.addButton('recentposts', {
    9 D& X1 V0 e5 o  h/ d' Y  s
  5.                                 title : 'Recent posts',8 g' {3 Z" ^6 Q" E2 i- W
  6.                                 image : url+'/recentpostsbutton.png',
    ( |7 X% @1 Q2 c% e& C2 |
  7.                                 onclick : function() {
    7 O( I$ a' C. w; l
  8.                                         var posts = prompt("文章數量", "1");5 V1 k: k% y* B4 }* U1 Y% ?
  9.                                         var text = prompt("請填入列表標題", "最新文章");
    5 D8 F+ p5 p+ w5 q
  10. # l: d& W( l: s: N* s* r
  11.                                         if (text != null && text != ''){
    ; s0 _7 u7 i. ^7 }
  12.                                                 if (posts != null && posts != '')
    $ Z; V; b  y$ X( \. q
  13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');1 F1 m, z9 Z2 C" t% E: w4 s5 E
  14.                                         else7 k, \1 G3 @0 b1 n- g
  15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
    8 }7 T7 x1 e0 {& l  o
  16.                                         }$ _, a4 f$ q7 Z6 A1 s7 v& r
  17.                                         else{
    2 z' f2 B0 c. k4 l/ G+ ]. J
  18.                                                 if (posts != null && posts != '')
    . z+ ^6 q0 k1 |2 s1 k/ e
  19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');' [3 e/ J& a2 K' z/ t
  20.                                                 else4 [* c" r9 r6 I5 i# A
  21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');9 z' s7 K+ x! c, S3 v
  22.                                         }
    7 O7 b  ^3 C. M9 G
  23.                                 }( X5 Z& D. n! g7 C* C& w
  24.                         });; y3 H) z1 [# \4 V6 T7 n  O" k
  25.                 },
    + E5 ]/ E6 t- o
  26.                 createControl : function(n, cm) {* ?9 ]* p+ N. O/ S* x  F( p
  27.                         return null;; O2 {6 F  A. h( x9 ]
  28.                 },
    1 f7 ~5 C8 p6 z. y# C2 ?7 S, a
  29.                 getInfo : function() {
    1 k7 o8 |- P# U' u4 B. ]
  30.                         return {
    0 ^0 l+ p# x1 [
  31.                                 longname : "Recent Posts",5 w; y. J% E6 q8 k: H" ]
  32.                                 author : 'Specs',( y( |6 A+ _+ b% `1 d
  33.                                 authorurl : 'http://9iphp.com',
    7 g' r& ~5 }4 j4 D9 B
  34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    , j3 s2 I4 q: w/ q0 C7 M6 d8 x
  35.                                 version : "1.0"
      c# L# r( o% Q# L5 j( R: l+ n
  36.                         };% D; o9 h8 w0 s0 I* n8 z% r3 P8 m
  37.                 }5 o$ p1 \3 p3 Z4 B+ Q7 T! i
  38.         });
    8 m! q* c2 p7 N3 S. I& b
  39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    : u0 G$ I& s: p
  40. })();
複製代碼
我們透過呼叫 tinymce.create() 建立了一個插件。代碼中最重要的是 init() 函數，我們定義了一個名字，一個icon文件及 onclick() 事件處理程序。
在 onclick() 函數的前兩行，依序彈出兩個對話框讓用戶輸入文章數量及列表標題兩個參數，然後根據用戶輸入，把短代碼插入到編輯器中。
最後，TinyMCE插件透過 add() 函數增加到 PluginManager。現在我們已經成功的整合了 [recent-posts] 短代碼到Wordpress中。
$ R! W0 g6 C! K+ b
4.2 註冊按鈕及TinyMCE插件* q1 D  r2 h2 c! D+ G  y2 `; Z

% w  d" I/ Y7 e2 w$ O$ W* `2 Q  g
當您完成建立的JS 檔 , 我們現在需要註冊它和短代碼按鈕。 因此我們建立了兩個函數並把它們繫結至適當的 wordpress 過濾器中。
第一個叫做 register_button() 的函數把短代碼增加到按鈕陣列中，在現有按鈕和新按鈕之間增加分割線。
  1. function register_button( $buttons ) {
    2 |$ k( J+ G3 q4 N7 _. y
  2.         array_push( $buttons, "|", "recentposts" );# {, E. u- ^, e
  3.         return $buttons;
    7 K3 _, W$ C) Q3 M3 W8 ~
  4. }
複製代碼
第二個函數 add_plugin() 指定JS文件的路徑及文件名。
+ {2 F. j9 S  O8 z
  1. function add_plugin( $plugin_array ) {
    ( \4 s7 f9 q6 k& B3 j6 {# n
  2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
    . \# r0 r" z) |1 |  P( G
  3.         return $plugin_array;
    1 c) c% w  h* `9 K
  4. }
複製代碼
下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。
! {: I( X" o: n, u: K, b0 A
  1. function my_recent_posts_button() {
    , j) n9 D- A7 R% ]& T
  2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {
    / J5 ~" t* `$ G2 u/ U/ F
  3.                 return;
    : ?+ a3 F( n: Z7 G8 `& b0 ]0 e; a1 l/ D
  4.         }
    ( E* x, @2 B+ E# R
  5. 3 f6 F+ ?% b* O9 L. K
  6.         if ( get_user_option('rich_editing') == 'true' ) {
    4 H5 n. O3 P1 s) _/ d4 G) c: P
  7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
    0 D1 s/ X, `" V* p) @4 m* k
  8.                 add_filter( 'mce_buttons', 'register_button' );
    # Z" K- x7 M+ v$ r3 T$ e
  9.         } 1 _/ |" T! v& T, g; B3 @
  10. }
複製代碼
當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。- s/ t2 l( z, ~4 g
最後把函數勾到Wordpress初始化函數
  1. add_action('init', 'my_recent_posts_button');
複製代碼

4 [, O, N6 g2 I- W' M4.3 按鈕的用法

$ P* L6 z1 B% j& [! K
為了測試程式碼是否正確，我們打開一篇新的文章，這時一個我們剛剛定義的按鈕是不是已經出現在第一行的末尾了？如下圖所示：
' w  Q7 ~- y/ L8 J0 W
點擊按鈕的時候，會彈出對話框讓我們輸入文章的數量：

2 @7 a4 `% a! o! v0 r8 C, D
輸入完點擊確定後，會彈出第二個對話框，讓我們輸入列表的標題：

& W* X$ i9 V1 p3 u  v6 x
參數留空的話，不會出現在最後的代碼中。最後，短代碼會新加到編輯器中：

5 z* u. i& R2 ?6 P) @+ P
到此就大功告成了。想要增加其他功能的短代碼及按鈕可以參考上面的教學，如法炮製舉一反三，相信可以製作出符合各位需求的短代碼功能。
參考文章: 1 2




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