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

標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕 [打印本頁]
作者: IT_man    時間: 2016-6-9 12:40
標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕
WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
- l! ?$ w2 r8 A& V  `( `- N5 L
: ~6 }2 s, X' Cwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
6 U  S# [& l) ^# ?" x; Z  D9 j) ^以下是 wordpress 短代碼的詳细介紹及進階應用。
9 v6 W6 ~. M1 t; K" v1 ?' m3 f! V, M8 q4 g* O2 @; q
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :# V: U8 `: t& z7 P& C
  1. [recent-posts]
複製代碼
此外 , 我們可以設定一個參數來控制文章的數量 :% u% q/ i# u" F6 K/ A5 w
  1. [recent-posts posts="5"]
複製代碼
此外 , 我們也可以為文章列表新增一個標題 :7 x2 f! H; h% z% h" k
  1. [recent-posts posts="5"]Posts Heading[/recent-posts]
複製代碼

' K0 E) k6 s1 W3 M* p
$ ^. ?9 Z. D/ o1. 簡單的短代碼
$ n6 d) N6 y* `5 I本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
8 N; M0 I* @* f! w+ i- g
  1. [recent-posts]
複製代碼
該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :. k' b( X- p; C- M  d6 I
  E: ]7 R6 R% G3 C: P9 R4 @
本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。0 E+ }- p- c. p1 Z# _
1.1 建立返回函數
4 v+ J; b1 C* W- `2 A0 G. d當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。& o0 ]7 k  i$ X/ K$ p; z* F
  1. function recent_posts_function() {
    & H7 V; b+ F! H3 t# K# M) {" ~
  2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
    6 k2 O" M" }- r! l( a1 r
  3.         if (have_posts()) :
    7 q/ n' }1 k3 N' e: _
  4.                 while (have_posts()) : the_post();
    & _8 V; c" ]5 B: I# l3 T% D
  5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
      z. c, q8 Z% |+ \9 Q
  6.                 endwhile;# J& ^8 s& _7 Q) _
  7.         endif;
    ( d& M2 ]- x' Z. [3 _' C3 B, b% Z2 v2 _
  8.         wp_reset_query();
    + z% [1 V- d" {  U" h
  9.         return $return_string;+ O4 ?4 n) i" g
  10. }
複製代碼
如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。2 L* J+ L' T  P6 a

- W1 K4 t5 N+ W- @. z9 y# K6 X$ n& [( a1 [; P0 V! M
1.2 註册短代碼
' m3 S6 u! M. t現在，我們告訴Wordpress這個函數是一個短代碼：
  1. function register_shortcodes(){4 U1 o; |. ]+ q, {; u9 V
  2.         add_shortcode('recent-posts', 'recent_posts_function');
    9 y4 A; a4 q. a4 Z! b* Q
  3. }
複製代碼
當在文章的內容中使用短代碼5 @1 [6 T& n+ B# C
  1. [recent-posts]
複製代碼
將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。
" w" W9 `+ O1 k. l; a" O+ {5 H" P8 ]1 E+ ~# {) S2 s: |: d
/ P. j1 h: W) U4 \* F; g2 Q
1.3 Hook into WordPress# X7 D/ U& h, p; D9 M

1 ^# i: e* V8 ?. y3 A5 s) \, s: `7 q為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。) r# f% @# \* ^; r# t
  1. add_action( 'init', 'register_shortcodes');
複製代碼
/ X0 u. U% D, k( a  I4 f4 A
1.4 測試短代碼' y6 ?' p! u) g6 H9 a; I
簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :
  1. [recent-posts]
複製代碼
2. 進階短代碼
2.1 短代碼参數
短代碼是非常有彈性 , 因為它讓我們加入參數可讓它們有更多的功能。 假設我們必須要顯示某一特定數量的最新的文章。 為了達到這個目的 , 我們需要給短代碼指定其他選項以顯示最近的文章數。
我們需要使用兩個函數 ,第一個是內建在 wordpress 的shortcode _ atts ( ) 函式 , 它把用戶的短代碼屬性與本地屬性結合在一起 , 並填入到想要的位置。 第二個是 PHP的extract() 函数 , 顧名思義 , 它萃取出短代碼中的各個屬性。
展開我們的返回功能 , 我們新增一個參數 $atts, 它是一個陣列,從中可以提取到我們需要的文章數。 我們查詢資料庫來取得指定數目的文章 , 並傳回一個列表 :
  1. function recent_posts_function($atts){
      l# \  j8 j% u2 X' i: i
  2.         extract(shortcode_atts(array(5 c! @( o* @" j$ h$ ^8 n3 {
  3.                 'posts' => 1,+ M' o" j5 u7 ?
  4.         ), $atts));
    & x+ z1 n+ F) t- C8 j

  5. ' d$ c' P8 F% f
  6.         $return_string = '<ul>';% |/ a+ _) r( S1 X; |# R0 N
  7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));; H! m) A3 @5 X% j$ b/ t7 y- C# \7 D" `
  8.         if (have_posts()) :6 ], M: q! a( ?1 U# G3 p
  9.                 while (have_posts()) : the_post();
    % l/ }1 }. S$ ]! x
  10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    4 J% I5 P" N' |9 o
  11.                 endwhile;( v" B( F, s& ^+ n/ p
  12.         endif;$ x- t! L" R5 `/ }! V
  13.         $return_string .= '</ul>';
    & q* Z7 u5 }  w6 K9 A  i

  14. & C; w8 [% u8 j
  15.         wp_reset_query();. b: y( ^1 \% U) k) B
  16.         return $return_string;9 ~2 l# q" S  |, g% n+ z0 d% }
  17. }
複製代碼
如果使用者未指定此選項 , 1 將是預設值。 我們可以加入多個屬性使短代碼接受更多的參數。 使用這項強化函數 , 我們就可以指定調用最新文章的數量 :
  1. [recent-posts posts="5"]
複製代碼
當顯示於瀏覽器 , 您就可以看到最近的五篇文章列表
6 i5 L# l0 o2 r# n4 I* {$ z: c
2.2 短代碼中增加内容
我們可以繼續擴展我們的短代碼、新增一些內容作為參數 來傳遞, 例如"最新文章列表的標題"。 若要達成此目的 , 我們需要在返回函數中新增第二個參數$content , 並把它顯示在列表前面的一個 <h3> 標簽中。新的函數如下：
  1. function recent_posts_function($atts, $content = null) {
    6 j4 {. ^+ E, [
  2.         extract(shortcode_atts(array(
      Q! F4 E/ y0 p# _/ b9 Z
  3.                 'posts' => 1,; Y0 ]# _, l+ p0 G- V2 S) J% P; z! q
  4.         ), $atts));$ a4 i$ o2 m/ ]) ?+ k4 K8 c# z

  5. + @" u& \2 @. ]0 Z2 h" e
  6.         $return_string = '<h3>'.$content.'</h3>';
    ' ]: ~' G1 Y9 {/ i6 C, F
  7.         $return_string .= '<ul>';: W" ^9 W' }. c; c
  8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
    7 c& `/ Y- K8 M1 M7 G
  9.         if (have_posts()) :/ g6 Y9 |  ~' w9 ]$ X1 z
  10.                 while (have_posts()) : the_post();$ Q' H- P/ b( _* u' J* f/ z
  11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    & f. a7 H8 Y0 R! l. H$ ~
  12.                 endwhile;
    ( Y2 w# x. l* E  M  V' Z$ R
  13.         endif;* F: `8 e6 U% y9 G. e
  14.         $return_string .= '</ul>';2 {7 \# E: w  z4 x
  15. - K8 e+ B; b9 f1 W
  16.         wp_reset_query();
    3 }0 @) a( e) u2 q
  17.         return $return_string;6 I6 E4 Q" ?; Y+ Z1 Q8 `
  18. }
複製代碼
這種短代碼類似於一個HTML標簽：
  1. [recent-posts posts="5"]This is the list heading[/recent-posts]
複製代碼
除了文章列表多了一個標題，其餘的內容和上一個示例是一樣的：

0 A0 b) X: L3 Y9 p. d% H8 {8 Z0 N
3. 在任何地方顯示短代碼
3.1 在側邊攔小工具中使用短代碼
預設情況下 , 側邊欄小工具是忽略短代碼的，您可以將此程式碼放在小工具

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

  P  ], l. \& P7 k9 V5 N4.1 透過JS文件來建立按鈕
JS文件是透過 TinyMCE API 來註冊 TinyMCE 插件的。我們在主題的 js 目錄下(/wp-content/themes/你主題名稱/js/)建立 recent-posts.js ，並貼進去下面的代碼（需要把按鈕圖片檔(/wp-content/themes/你主題名稱/js/recentpostsbutton.png)也放在同一個目錄）：
  1. (function() {( a1 P+ j- D$ J5 _& c0 K
  2.         tinymce.create('tinymce.plugins.recentposts', {6 W# L0 G' l0 {  @
  3.                 init : function(ed, url) {
    " K) p9 `/ Y9 x# w- R, B
  4.                         ed.addButton('recentposts', {# a  i5 J9 {/ L$ J* o
  5.                                 title : 'Recent posts',
    ' n7 @, Y+ t' o/ n+ h
  6.                                 image : url+'/recentpostsbutton.png',5 b8 h- E2 h! _8 ]6 k7 g- j3 d) j8 f# O
  7.                                 onclick : function() {
    9 e% e. _) J- s. D( V
  8.                                         var posts = prompt("文章數量", "1");, [1 h2 P1 W% w  v! W" z! n" ^& \
  9.                                         var text = prompt("請填入列表標題", "最新文章");
    1 T, G% a4 x. D% n, I5 o
  10. " m# ]9 ?& V# N1 \8 y
  11.                                         if (text != null && text != ''){: o. V' U8 G4 j, A, c
  12.                                                 if (posts != null && posts != '')5 b  q, ?( G7 t9 U
  13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');+ g9 j: j/ a" B4 x8 H
  14.                                         else
    & u* g' N7 ~2 B% i0 O! E  w# l
  15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');+ Z- m# ?6 Z# N
  16.                                         }! E( m5 h" Z" b& [
  17.                                         else{
    ! E5 z1 O# B' s8 K. a2 L& n' h
  18.                                                 if (posts != null && posts != '')
    + V) v; n" J# g5 v
  19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');" N! u5 o! a; ~4 c8 U/ Z
  20.                                                 else2 A; k0 A, R+ {9 o9 p- _, B: [9 R; R
  21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    ! U/ \3 }0 ]( O: I. x$ v4 z8 d7 k9 U
  22.                                         }, B, w" V* w1 F6 l* O2 A
  23.                                 }
    4 K, t* ]; M+ _& m3 F3 t4 a
  24.                         });
    / W, o4 ~2 _- k7 V8 w+ |* A8 r+ s1 H6 m
  25.                 },; x  W8 N$ \; f  U# e
  26.                 createControl : function(n, cm) {
    " m; l& W' w/ {! `) ]9 {
  27.                         return null;
    7 N0 z7 @5 n1 [! c1 X
  28.                 },/ n% U$ r4 p- B: |. G
  29.                 getInfo : function() {
    % z, }5 e0 K$ v6 K) Z. H9 Q
  30.                         return {
    6 f! ~3 W, }0 {( E6 U& t- c6 G+ i* G
  31.                                 longname : "Recent Posts",
    * ~3 j- k+ r* T9 Q4 d
  32.                                 author : 'Specs',/ O7 ^5 N" ^0 H
  33.                                 authorurl : 'http://9iphp.com',
    8 e: _4 `) ?( e6 J8 {
  34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',# V% n" r5 t0 R# m7 s
  35.                                 version : "1.0"' ]1 O3 {' f, q8 Q0 a) J7 j/ q
  36.                         };
    " ^% ~1 e9 K5 \  \
  37.                 }
    $ g9 {6 d2 c, y. b
  38.         });
    ; a1 N% `+ x- M' L
  39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);0 ~1 q+ a3 i* y
  40. })();
複製代碼
我們透過呼叫 tinymce.create() 建立了一個插件。代碼中最重要的是 init() 函數，我們定義了一個名字，一個icon文件及 onclick() 事件處理程序。
在 onclick() 函數的前兩行，依序彈出兩個對話框讓用戶輸入文章數量及列表標題兩個參數，然後根據用戶輸入，把短代碼插入到編輯器中。
最後，TinyMCE插件透過 add() 函數增加到 PluginManager。現在我們已經成功的整合了 [recent-posts] 短代碼到Wordpress中。

2 M" H2 i& ]9 R
4.2 註冊按鈕及TinyMCE插件
( E8 {) P& _1 |# k, g5 a/ q: i9 u! c* G. ]; I
當您完成建立的JS 檔 , 我們現在需要註冊它和短代碼按鈕。 因此我們建立了兩個函數並把它們繫結至適當的 wordpress 過濾器中。
第一個叫做 register_button() 的函數把短代碼增加到按鈕陣列中，在現有按鈕和新按鈕之間增加分割線。
  1. function register_button( $buttons ) {
    7 ?* o. y5 N- I4 r
  2.         array_push( $buttons, "|", "recentposts" );
    * I& l; q) o" s8 [5 c  X' [
  3.         return $buttons;
    ) f0 x% m2 O0 O
  4. }
複製代碼
第二個函數 add_plugin() 指定JS文件的路徑及文件名。/ r3 k, |! d, v
  1. function add_plugin( $plugin_array ) {  \+ m8 R" |5 s) [! ~; p
  2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';" a+ w" V& b& Q2 V; O
  3.         return $plugin_array;% ~1 W7 u8 X8 Y# [
  4. }
複製代碼
下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。4 O# L4 h4 k& `- b, y# U! K# h2 e8 r1 ^
  1. function my_recent_posts_button() { / @2 }7 [9 @6 n$ |
  2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {, R6 E& j- w% s, b' y2 C4 t  [- V- x6 n
  3.                 return;9 v2 B. E- _2 r8 j/ y
  4.         }
    & i& q: s9 Y9 I" Y. `

  5. 8 h1 Z/ d4 M& x; }8 ^" [0 p  h, X# @
  6.         if ( get_user_option('rich_editing') == 'true' ) {
    - {# h2 @4 p6 T# _6 R
  7.                 add_filter( 'mce_external_plugins', 'add_plugin' );; J7 @# m- ~9 ^- x
  8.                 add_filter( 'mce_buttons', 'register_button' );
    ! `0 W4 \8 n8 h: D) J! ~" b
  9.         } - W: Q: {- |8 V- l* K
  10. }
複製代碼
當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。; D0 P0 I2 O4 V. O
最後把函數勾到Wordpress初始化函數
  1. add_action('init', 'my_recent_posts_button');
複製代碼
7 Q2 M8 `8 l& Z/ c& U( t* f
4.3 按鈕的用法

/ w3 [. r6 a8 H8 t2 L" k: D% n
為了測試程式碼是否正確，我們打開一篇新的文章，這時一個我們剛剛定義的按鈕是不是已經出現在第一行的末尾了？如下圖所示：

* b3 u, d  Q% v8 C/ O! p! I
點擊按鈕的時候，會彈出對話框讓我們輸入文章的數量：
7 U  {5 z7 b1 I: s! e- f, U
輸入完點擊確定後，會彈出第二個對話框，讓我們輸入列表的標題：

, l- F+ a6 \. n7 c% t% D1 }
參數留空的話，不會出現在最後的代碼中。最後，短代碼會新加到編輯器中：

. {" o, k3 `  K2 D
到此就大功告成了。想要增加其他功能的短代碼及按鈕可以參考上面的教學，如法炮製舉一反三，相信可以製作出符合各位需求的短代碼功能。
參考文章: 1 2




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