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

標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕 [打印本頁]
作者: IT_man    時間: 2016-6-9 12:40
標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕
WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
5 J! _* `7 q8 J. v4 E7 S  U) K; u$ t5 d0 X7 l% f! h* z$ r1 j
wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
% @6 d$ Y( Y4 U  M. [3 [  k$ z以下是 wordpress 短代碼的詳细介紹及進階應用。
4 ^( o8 j! W" Z3 o: Q# W  e
5 k& @6 J4 B; V" m* |短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :; y- R5 G/ u6 V" a
  1. [recent-posts]
複製代碼
此外 , 我們可以設定一個參數來控制文章的數量 :
1 x* R4 i. B0 m2 X& S1 e, p! f
  1. [recent-posts posts="5"]
複製代碼
此外 , 我們也可以為文章列表新增一個標題 :+ }, Z9 X+ b' h3 Q& [  W
  1. [recent-posts posts="5"]Posts Heading[/recent-posts]
複製代碼
! m2 j% k1 B, q% k" E' X

5 }% w3 I3 a/ S* r5 p1. 簡單的短代碼
5 Y' Q) }; Z( m2 Y7 @4 R% M本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
8 m; S* b) }! p; S0 i: s# t$ e
  1. [recent-posts]
複製代碼
該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :$ j8 V9 G. x0 T4 K
0 |# t" {# P, A5 `9 \/ U# p
本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
  D1 w; \3 v# Q4 m9 Q1.1 建立返回函數
; `) Y9 d# j$ N' A3 y( i. }當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。4 d: l" I1 a  S  m
  1. function recent_posts_function() {/ ^! C/ @/ U- ^9 v4 Y
  2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
    % Z3 L, c; ]/ ]/ e- V$ ]( _* o
  3.         if (have_posts()) :
    7 q- Q6 h, Q/ u
  4.                 while (have_posts()) : the_post();
    ) `: k' o& i. V. Z% N' N, y( W8 g1 m
  5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
    7 [2 U: d. v9 n$ v% x
  6.                 endwhile;
    : r- ?: E  h+ Y4 B, C! E
  7.         endif;
    2 b! K# Q) X+ g- Z4 Q6 o
  8.         wp_reset_query();# m. y6 e, ~! y: j  |( ]& V, h
  9.         return $return_string;
    8 z5 s- D7 @; ^$ A4 o9 |- F
  10. }
複製代碼
如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。* x7 {* x+ @) F3 c, c: |" E
1 x8 m) G. ^0 j. p/ b! E

  e: l" K5 y9 i1 M& K% H' |1.2 註册短代碼
2 M5 ~# p7 q+ q' {, L& _1 `現在，我們告訴Wordpress這個函數是一個短代碼：
  1. function register_shortcodes(){
    $ q0 @! e  d6 \  g- D/ g1 W
  2.         add_shortcode('recent-posts', 'recent_posts_function');6 _; ~% D  F0 S* D; p/ \
  3. }
複製代碼
當在文章的內容中使用短代碼; z& z) {5 y: Y+ s3 l
  1. [recent-posts]
複製代碼
將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。
9 i6 G$ }' u5 J- O# |% t( G/ ?/ b2 m9 R% K
& f, U* a" N( S' S' ^
1.3 Hook into WordPress, }7 u( U& V: d% g

1 ^8 V0 L& X% f) W. `" E/ {  Z為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。0 W8 G4 L4 J1 C8 x* N( S7 k+ ^
  1. add_action( 'init', 'register_shortcodes');
複製代碼

3 w. W, P" w1 k) T5 G1.4 測試短代碼
' \8 M0 T1 s1 e8 {簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :
  1. [recent-posts]
複製代碼
2. 進階短代碼
2.1 短代碼参數
短代碼是非常有彈性 , 因為它讓我們加入參數可讓它們有更多的功能。 假設我們必須要顯示某一特定數量的最新的文章。 為了達到這個目的 , 我們需要給短代碼指定其他選項以顯示最近的文章數。
我們需要使用兩個函數 ,第一個是內建在 wordpress 的shortcode _ atts ( ) 函式 , 它把用戶的短代碼屬性與本地屬性結合在一起 , 並填入到想要的位置。 第二個是 PHP的extract() 函数 , 顧名思義 , 它萃取出短代碼中的各個屬性。
展開我們的返回功能 , 我們新增一個參數 $atts, 它是一個陣列,從中可以提取到我們需要的文章數。 我們查詢資料庫來取得指定數目的文章 , 並傳回一個列表 :
  1. function recent_posts_function($atts){  c7 m3 \* \0 U# p2 W
  2.         extract(shortcode_atts(array(
    / O3 O1 N( x$ g1 W
  3.                 'posts' => 1,
    8 V7 D+ x3 z* e. P" j5 c% b6 n
  4.         ), $atts));
    ; }/ D) ^9 N' w

  5. ; @) g$ N! Q8 h) u8 |) J8 F, A
  6.         $return_string = '<ul>';
    5 G) r. J5 D4 S/ g8 ?2 p
  7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));! D% `4 T% c$ @, b9 d0 Z
  8.         if (have_posts()) :
    + J9 Q2 \% m% }) b0 M
  9.                 while (have_posts()) : the_post();/ _. m) a3 f+ j4 U! M6 C4 a
  10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';0 W5 W6 E" K; R* |& K/ r
  11.                 endwhile;
    + q' U( r/ \2 f: ?5 h' H  M( c
  12.         endif;
    ' Y* q; f- h" Q4 L- l) g
  13.         $return_string .= '</ul>';
    " [1 F9 Y' i) F" }

  14. & f0 D3 N. Q- Y! h6 {  i+ t
  15.         wp_reset_query();
    ) c8 ^. b) D; l1 q( c" f& @
  16.         return $return_string;9 [2 T: J3 T# ~( W9 d0 A$ p
  17. }
複製代碼
如果使用者未指定此選項 , 1 將是預設值。 我們可以加入多個屬性使短代碼接受更多的參數。 使用這項強化函數 , 我們就可以指定調用最新文章的數量 :
  1. [recent-posts posts="5"]
複製代碼
當顯示於瀏覽器 , 您就可以看到最近的五篇文章列表

% O" k: [* A( F& j" {7 {% r  A2.2 短代碼中增加内容
我們可以繼續擴展我們的短代碼、新增一些內容作為參數 來傳遞, 例如"最新文章列表的標題"。 若要達成此目的 , 我們需要在返回函數中新增第二個參數$content , 並把它顯示在列表前面的一個 <h3> 標簽中。新的函數如下：
  1. function recent_posts_function($atts, $content = null) {
    6 w8 t& u; L, p& y" o* G
  2.         extract(shortcode_atts(array(6 o6 y2 Y. t- H8 F' G
  3.                 'posts' => 1,
    " o+ x5 p+ e& T7 r, y6 Y9 ^' E" _/ [. ?
  4.         ), $atts));
    ! V: V* ^: q7 {4 I: _
  5. ( S0 U) d5 y: S1 ^
  6.         $return_string = '<h3>'.$content.'</h3>';4 e. {9 Z% c1 Q$ |5 R* h1 r+ O2 R
  7.         $return_string .= '<ul>';" M8 G4 R: Y( [: i
  8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
    8 Y8 B) ]  N. v& ~% T: i: T
  9.         if (have_posts()) :
    ; ]1 `( @3 g# B& q
  10.                 while (have_posts()) : the_post();2 z. ~& ?% x& t7 B. H5 [
  11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';9 y9 Z- t: o$ @
  12.                 endwhile;
    9 B3 D5 r/ r1 `" O
  13.         endif;0 [! E  m9 e4 T# M0 {  D: {
  14.         $return_string .= '</ul>';
    * J* b  R6 g* N$ y" U

  15. 0 z1 o# x' p) W+ @0 F
  16.         wp_reset_query();4 {" r; N' W- t6 C% X
  17.         return $return_string;
    , m3 {! z& D# C, }* b
  18. }
複製代碼
這種短代碼類似於一個HTML標簽：
  1. [recent-posts posts="5"]This is the list heading[/recent-posts]
複製代碼
除了文章列表多了一個標題，其餘的內容和上一個示例是一樣的：
/ T( P7 y+ v0 H3 P6 i, C! o+ ~( e
3. 在任何地方顯示短代碼
3.1 在側邊攔小工具中使用短代碼
預設情況下 , 側邊欄小工具是忽略短代碼的，您可以將此程式碼放在小工具
; D3 L1 v" z+ }
我們可以採用一行程式碼來啟用這個函數 , 為了使側邊欄小工具支援短代碼 , 新增以下的程式碼 :
  1. add_filter('widget_text', 'do_shortcode');
複製代碼
現在不需要修改任何其他地方 , 刷新頁面, 側邊欄將會正確地顯示
& q# }* m& Q6 ?) q$ P$ j1 V
同樣的，在評論中啟用短代碼：
  1. add_filter( 'comment_text', 'do_shortcode' );
複製代碼
在摘要中啟用短代碼：
  1. add_filter( 'the_excerpt', 'do_shortcode');
複製代碼
4. TinyMCE編輯器增加短代碼按鈕
/ }8 y  b  \8 {2 M$ E# y8 I
* @8 }) a% g7 Z- ]3 o雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。
要解決這個，我們可以給 TinyMCE編輯器增加一個按鈕，使用戶可以透過簡單的點擊來增加短代碼。建立這個按鈕僅需兩個步驟：

5 j% P7 A) x: O1 V' V  J; R, \; l4.1 透過JS文件來建立按鈕
JS文件是透過 TinyMCE API 來註冊 TinyMCE 插件的。我們在主題的 js 目錄下(/wp-content/themes/你主題名稱/js/)建立 recent-posts.js ，並貼進去下面的代碼（需要把按鈕圖片檔(/wp-content/themes/你主題名稱/js/recentpostsbutton.png)也放在同一個目錄）：
  1. (function() {0 E* \( b9 n0 u, I
  2.         tinymce.create('tinymce.plugins.recentposts', {! }5 |7 |! f' U
  3.                 init : function(ed, url) {
    . v/ y% Q: Q9 \3 i" d% j! U
  4.                         ed.addButton('recentposts', {
      P! D7 q' K4 H# h- Y) f
  5.                                 title : 'Recent posts',
      E( r8 ~! ^. ]3 O3 R" D3 q
  6.                                 image : url+'/recentpostsbutton.png',6 z) e" X$ q, {# b
  7.                                 onclick : function() {+ t) c2 e$ l+ _/ U/ ^4 i& C( }
  8.                                         var posts = prompt("文章數量", "1");
    / a; x3 h# l2 v" K7 i
  9.                                         var text = prompt("請填入列表標題", "最新文章");
    - U- P' }6 u& U* L
  10. - c- b' h9 a( t0 x* C1 E6 C! @* v
  11.                                         if (text != null && text != ''){
    * s4 ?7 D# _9 u( R. X& o
  12.                                                 if (posts != null && posts != '')
    0 R0 l5 v+ U" u/ I& h; K9 w
  13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');0 ?2 }: L$ |7 N5 f7 @
  14.                                         else0 u, V% ?9 R" I1 t: D5 E
  15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');# s7 H9 ]' ?4 J1 a- K
  16.                                         }
    6 l9 u! `# T. p- W, p$ O' {. b
  17.                                         else{
    1 s+ P3 _( P) }. B; P
  18.                                                 if (posts != null && posts != '')
    ! o9 o0 m2 E* t/ [3 Y/ y2 `
  19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');" q6 u6 q3 q: j
  20.                                                 else2 ~3 @+ e0 P; I4 k
  21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    ; [% G2 @  G5 p* A: V* R- g
  22.                                         }
    * S0 v" O) E, x
  23.                                 }
    9 ^. Q. E! B8 @
  24.                         });
    ) L6 f/ H7 g' k
  25.                 },
    4 s. @% @* ~8 D
  26.                 createControl : function(n, cm) {: ^. ~" R8 a: j8 \$ n4 n% y
  27.                         return null;
    9 s0 P& D; u. R+ n( X
  28.                 },4 t3 Z, i7 Q5 U4 ?3 p
  29.                 getInfo : function() {6 `! `2 l( Q* G3 M# D
  30.                         return {
    # L0 @# [/ K4 I% L5 C- W
  31.                                 longname : "Recent Posts",
    ) G1 A& l4 |3 V
  32.                                 author : 'Specs',3 F8 h4 T( n) U
  33.                                 authorurl : 'http://9iphp.com',
    ! v3 T7 [. X) x. H  ^, |
  34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    + L; U3 d! P6 ?  d6 \1 r
  35.                                 version : "1.0"
    % P# T* |6 Z' L! @
  36.                         };
    * R3 ]. W8 m3 k" u5 y8 I- K
  37.                 }$ }& I+ r* A6 Y1 Y* {
  38.         });$ B0 i" @! p0 M2 g3 ^
  39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);5 `9 I9 o3 l& E+ q
  40. })();
複製代碼
我們透過呼叫 tinymce.create() 建立了一個插件。代碼中最重要的是 init() 函數，我們定義了一個名字，一個icon文件及 onclick() 事件處理程序。
在 onclick() 函數的前兩行，依序彈出兩個對話框讓用戶輸入文章數量及列表標題兩個參數，然後根據用戶輸入，把短代碼插入到編輯器中。
最後，TinyMCE插件透過 add() 函數增加到 PluginManager。現在我們已經成功的整合了 [recent-posts] 短代碼到Wordpress中。

) Y' T" N) q, k% X% s' E
4.2 註冊按鈕及TinyMCE插件
) M& h* a3 |# s9 z4 R4 p4 ~7 ]+ |3 [) D- ]) X0 H
當您完成建立的JS 檔 , 我們現在需要註冊它和短代碼按鈕。 因此我們建立了兩個函數並把它們繫結至適當的 wordpress 過濾器中。
第一個叫做 register_button() 的函數把短代碼增加到按鈕陣列中，在現有按鈕和新按鈕之間增加分割線。
  1. function register_button( $buttons ) {
      p; m+ k" ~6 |2 I' U/ }6 B' O, p
  2.         array_push( $buttons, "|", "recentposts" );
    . \1 M8 J2 u6 Q$ W. ?. P" [
  3.         return $buttons;
    3 W1 N! U3 i" x. s
  4. }
複製代碼
第二個函數 add_plugin() 指定JS文件的路徑及文件名。
/ L" A4 ^  T0 D" K- p# E) i
  1. function add_plugin( $plugin_array ) {
    8 o7 c% L; }9 b# l1 V
  2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
    5 h8 J  Y$ d5 O. u0 p8 [
  3.         return $plugin_array;
    * [6 ]1 t0 @. Z8 O" q1 a
  4. }
複製代碼
下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。. o9 l: J7 k  n+ B- a7 |
  1. function my_recent_posts_button() {
    ! t1 N- ?: g: r1 f2 H( y6 y7 _" u/ F
  2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {! ]5 Q7 K5 M; m2 P  M( B
  3.                 return;
    ( S$ C: G1 U/ N, N# e! F% ^5 ]. u0 ?
  4.         }2 w6 g& y$ v" K  H0 ?; Y
  5. " {' T6 z2 A( t7 j2 Z: `
  6.         if ( get_user_option('rich_editing') == 'true' ) {
    : s. u* T- a; j, F% L" P
  7.                 add_filter( 'mce_external_plugins', 'add_plugin' );  B- n9 r9 _: y9 ~' s$ M- G
  8.                 add_filter( 'mce_buttons', 'register_button' );- V( C9 O6 P# B/ l! `' t7 F5 ^. o
  9.         } 2 x9 u+ ]& Y$ N- R- V
  10. }
複製代碼
當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
& V* F- x4 i, t- V最後把函數勾到Wordpress初始化函數
  1. add_action('init', 'my_recent_posts_button');
複製代碼

3 @3 v; w: k$ F3 k4.3 按鈕的用法

3 N1 v( F- U. ]( [
為了測試程式碼是否正確，我們打開一篇新的文章，這時一個我們剛剛定義的按鈕是不是已經出現在第一行的末尾了？如下圖所示：

. x) {5 i5 @+ |4 f9 _
點擊按鈕的時候，會彈出對話框讓我們輸入文章的數量：
6 u% B. }/ G2 X; e
輸入完點擊確定後，會彈出第二個對話框，讓我們輸入列表的標題：
  h: F$ E& t$ N5 p8 Z, w( S
參數留空的話，不會出現在最後的代碼中。最後，短代碼會新加到編輯器中：

6 a) h2 o% D: g1 i3 y
到此就大功告成了。想要增加其他功能的短代碼及按鈕可以參考上面的教學，如法炮製舉一反三，相信可以製作出符合各位需求的短代碼功能。
參考文章: 1 2




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