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

標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕 [打印本頁]
作者: IT_man    時間: 2016-6-9 12:40
標題: WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕
WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)
5 s: R. ]: B' Z( y' O. s' o
* Z& e; L% t1 t* E8 O9 ?0 }2 Zwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入，用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容，短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時，透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。1 F: v& J7 q; s5 \; L, B" d
以下是 wordpress 短代碼的詳细介紹及進階應用。! _- n" Y: l/ V" u3 G4 y+ A
, z9 q8 E- h5 ~+ z
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
/ y1 c% J/ ^1 F0 Y4 i
  1. [recent-posts]
複製代碼
此外 , 我們可以設定一個參數來控制文章的數量 :. d" ?( ]; I2 W6 L
  1. [recent-posts posts="5"]
複製代碼
此外 , 我們也可以為文章列表新增一個標題 :7 f' |5 F/ {9 R& Y2 A5 x; [4 l
  1. [recent-posts posts="5"]Posts Heading[/recent-posts]
複製代碼

$ c7 d4 Z, `( a6 B0 b5 q
, O7 o: Q6 B$ z, w4 y: X1. 簡單的短代碼7 o/ E$ s- k. A( n
本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
8 \: i+ I5 _. G! S$ P) q+ E0 Q" ^
  1. [recent-posts]
複製代碼
該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
; I) W9 _" j4 U, ?2 @8 J7 n8 M
' [" Q  g. a6 A+ v! h- u, X本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。6 p7 d6 x, w) w$ m
1.1 建立返回函數! c/ m7 d% y$ o' a3 Q3 L
當發現短代碼的時候，它會被一個稱作返回函數的一段代碼所代替，所以我們先建立一個函數，從資料庫中獲取最新的文章。4 \4 c4 F1 Y' a) h( m: u$ g' c4 P
  1. function recent_posts_function() {
    % E( f- B0 N- U3 s
  2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));# a! X: |( a* F2 S3 m7 Q/ x
  3.         if (have_posts()) :( x5 }+ D7 U$ R- j& Z: t
  4.                 while (have_posts()) : the_post();' o8 d! p9 [1 C8 S, T
  5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';
      S- l; ~: ^/ s' H% `5 S7 d
  6.                 endwhile;
    - ]# _. E0 p5 g
  7.         endif;
    / n& g! o7 v+ U! s& [1 L' ?" O
  8.         wp_reset_query();
    8 H+ n/ t; G" I! s  j/ q
  9.         return $return_string;
    & n: ^5 P) C! V5 S8 M% C1 |
  10. }
複製代碼
如上所示，我們查詢資料庫，獲取最新的文章，並返回一個帶有鏈接的字串。值得註意的是，返回函數並不印任何內容，而是返回一個字串。  h  S) G6 |0 g- v
; r! z! ~1 G4 a4 L. h) M
) `9 D5 g4 O$ T( G4 b; s% |
1.2 註册短代碼3 @8 p4 L: p, J' z( I
現在，我們告訴Wordpress這個函數是一個短代碼：
  1. function register_shortcodes(){$ N& R- E6 ?6 P: |" E
  2.         add_shortcode('recent-posts', 'recent_posts_function');  B3 _5 S  c+ X9 D$ d
  3. }
複製代碼
當在文章的內容中使用短代碼* ~9 j- Z) L/ B& U3 Y* z5 v
  1. [recent-posts]
複製代碼
將會自動呼叫 recent_posts_function() 函數，我們需要確保短代碼的名字是唯一的，以避免重複。
! l# y$ X* p! a  [
: n# A3 o: Y! y# w( V9 |( c7 N6 K, ?8 k1 X
1.3 Hook into WordPress" ^% Z* L. C& ~8 |

2 \6 u3 ~$ I, o7 {為了能夠執行 recent_posts_function() 函數，我們需要把它綁定在 WordPress 的初始化鉤子中。
! \. v0 x, v7 x# f
  1. add_action( 'init', 'register_shortcodes');
複製代碼

% e2 a! u3 J: }$ T8 m1.4 測試短代碼
$ T% G; X9 e/ u* U2 P簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :
  1. [recent-posts]
複製代碼
2. 進階短代碼
2.1 短代碼参數
短代碼是非常有彈性 , 因為它讓我們加入參數可讓它們有更多的功能。 假設我們必須要顯示某一特定數量的最新的文章。 為了達到這個目的 , 我們需要給短代碼指定其他選項以顯示最近的文章數。
我們需要使用兩個函數 ,第一個是內建在 wordpress 的shortcode _ atts ( ) 函式 , 它把用戶的短代碼屬性與本地屬性結合在一起 , 並填入到想要的位置。 第二個是 PHP的extract() 函数 , 顧名思義 , 它萃取出短代碼中的各個屬性。
展開我們的返回功能 , 我們新增一個參數 $atts, 它是一個陣列,從中可以提取到我們需要的文章數。 我們查詢資料庫來取得指定數目的文章 , 並傳回一個列表 :
  1. function recent_posts_function($atts){& o6 V7 o  _( _) t: l
  2.         extract(shortcode_atts(array() h5 u& D% B  \$ e; v) |  l  \
  3.                 'posts' => 1,
    * d& k2 g1 m, e- M
  4.         ), $atts));
    5 a0 X* s1 ^( A( q) ?- F& E1 V9 P

  5. 2 e& u- |2 h; j) V
  6.         $return_string = '<ul>';
    # E1 J/ p0 `; f0 ^( f0 w" C* I' p
  7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
    8 u# r! [$ ]+ p/ i$ \
  8.         if (have_posts()) :
    ) |+ G9 Z3 w+ ~' c
  9.                 while (have_posts()) : the_post();
    2 K4 i& L3 Y( w$ K
  10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    & B) Q, p& M% q* c4 z, N, Y
  11.                 endwhile;- l! \# ~' M2 ?: }
  12.         endif;
    7 A6 H. f* k! B% q! @- y
  13.         $return_string .= '</ul>';
    9 I! u6 x# @  V  Q8 |, g
  14. * a% b9 w' c& g" [
  15.         wp_reset_query();2 _. A! @- C4 w7 l! I
  16.         return $return_string;; c. q. r3 h  ^( i. }
  17. }
複製代碼
如果使用者未指定此選項 , 1 將是預設值。 我們可以加入多個屬性使短代碼接受更多的參數。 使用這項強化函數 , 我們就可以指定調用最新文章的數量 :
  1. [recent-posts posts="5"]
複製代碼
當顯示於瀏覽器 , 您就可以看到最近的五篇文章列表

* e4 }4 b3 ]9 |! m4 h6 ]( f2.2 短代碼中增加内容
我們可以繼續擴展我們的短代碼、新增一些內容作為參數 來傳遞, 例如"最新文章列表的標題"。 若要達成此目的 , 我們需要在返回函數中新增第二個參數$content , 並把它顯示在列表前面的一個 <h3> 標簽中。新的函數如下：
  1. function recent_posts_function($atts, $content = null) {
    3 {: w  f# n+ \( X! a7 T
  2.         extract(shortcode_atts(array(
      L4 s% k* r8 Z- P
  3.                 'posts' => 1,! w7 f& I2 E" n4 a
  4.         ), $atts));
    2 ]& l9 i0 A4 g7 ^

  5. " l# S% A0 M! T! p
  6.         $return_string = '<h3>'.$content.'</h3>';
    : [( `( f+ q5 S, J" p1 x' y
  7.         $return_string .= '<ul>';
    . Y  v# T1 q& y% y" @* F( P! P) y
  8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
    4 ?0 U- j# B0 I" \; R
  9.         if (have_posts()) :& [5 B  k- w& i
  10.                 while (have_posts()) : the_post();1 f! |5 l- `% m0 G
  11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    ) I" }6 Q# R+ R* {% Z% `
  12.                 endwhile;
    " t* k7 s& a3 E* L# h+ C
  13.         endif;2 k$ o9 R$ {  I. \
  14.         $return_string .= '</ul>';
    6 R4 k. g6 S( L7 j7 ^

  15. 1 U0 a/ ~4 U4 Q  {: W) }2 I. I
  16.         wp_reset_query();1 L/ H" d' n/ f# {# r
  17.         return $return_string;! v4 i' Y! r+ s# G- Q* u
  18. }
複製代碼
這種短代碼類似於一個HTML標簽：
  1. [recent-posts posts="5"]This is the list heading[/recent-posts]
複製代碼
除了文章列表多了一個標題，其餘的內容和上一個示例是一樣的：
- a% I1 Q4 Q- f3 U
3. 在任何地方顯示短代碼
3.1 在側邊攔小工具中使用短代碼
預設情況下 , 側邊欄小工具是忽略短代碼的，您可以將此程式碼放在小工具
& C1 b/ ^! ~! L: X6 W
我們可以採用一行程式碼來啟用這個函數 , 為了使側邊欄小工具支援短代碼 , 新增以下的程式碼 :
  1. add_filter('widget_text', 'do_shortcode');
複製代碼
現在不需要修改任何其他地方 , 刷新頁面, 側邊欄將會正確地顯示
( k7 j8 C* w7 f& |* q" b
同樣的，在評論中啟用短代碼：
  1. add_filter( 'comment_text', 'do_shortcode' );
複製代碼
在摘要中啟用短代碼：
  1. add_filter( 'the_excerpt', 'do_shortcode');
複製代碼
4. TinyMCE編輯器增加短代碼按鈕  I2 Q% T. e" a* y# S8 _$ e

4 u7 O( h0 y5 ~! V  z2 x雖然短代碼可以方便的為文章增加動態內容，但是這對於普通用戶來說可能還是有點複雜，尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉，然而要使用短代碼，他們必須記住具體的語法與參數，因為即使是一個小小的語法錯誤，都可能導致意想不到的結果。
要解決這個，我們可以給 TinyMCE編輯器增加一個按鈕，使用戶可以透過簡單的點擊來增加短代碼。建立這個按鈕僅需兩個步驟：
3 M- g+ O: r/ u8 Y/ _* |2 Y1 q
4.1 透過JS文件來建立按鈕
JS文件是透過 TinyMCE API 來註冊 TinyMCE 插件的。我們在主題的 js 目錄下(/wp-content/themes/你主題名稱/js/)建立 recent-posts.js ，並貼進去下面的代碼（需要把按鈕圖片檔(/wp-content/themes/你主題名稱/js/recentpostsbutton.png)也放在同一個目錄）：
  1. (function() {
    . B& r: u7 N. i4 P3 N. V7 W, L
  2.         tinymce.create('tinymce.plugins.recentposts', {
    " u' }3 l' w' y( P" s- I# @
  3.                 init : function(ed, url) {' `& s# p$ o6 J% v, c
  4.                         ed.addButton('recentposts', {
    $ S! Y* _1 O8 L' N. `0 y( E9 B
  5.                                 title : 'Recent posts',+ E4 _  g/ F& ^( S# v
  6.                                 image : url+'/recentpostsbutton.png',8 \. c+ Y$ n: h% @/ x7 ?
  7.                                 onclick : function() {
    0 i4 t' k2 P; N) }- l6 [
  8.                                         var posts = prompt("文章數量", "1");: p8 U* @! {0 `4 D- }8 }
  9.                                         var text = prompt("請填入列表標題", "最新文章");( F+ d8 h# ]+ [3 G# \
  10. ) l5 E7 N; o+ g% w" b
  11.                                         if (text != null && text != ''){
    $ D. E2 O0 a- a9 @3 L8 g) Q& Y; @
  12.                                                 if (posts != null && posts != '')
    1 m& Q- A& _7 U+ e$ W
  13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');4 ]+ F% z; S$ \% p2 a# m
  14.                                         else
    , ?" a! S; F7 k, ^
  15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');% R, w6 r; j* K; @/ }" H5 m
  16.                                         }7 V* \$ S6 W' V! E- e8 m# f
  17.                                         else{* g, [# l& C! i
  18.                                                 if (posts != null && posts != '')
    , x/ E) d4 q: @
  19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');5 B. G" ]& V: m) y
  20.                                                 else
    % j! z$ D# Q, |' W0 [& i
  21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');3 e) u: u6 r2 u3 }1 Z$ T
  22.                                         }
    4 y* X) U3 B' z2 r
  23.                                 }8 w9 s) v& P- I5 ^/ g/ R  R+ R
  24.                         });* b1 |) ?& f/ x6 p- L5 @. ~
  25.                 },# b1 o! X* y- a- `
  26.                 createControl : function(n, cm) {6 c7 U+ q5 T6 R3 Q0 c- W
  27.                         return null;
    3 Y0 x% t4 U( [. N2 J$ _
  28.                 },
    ! c4 x' R  C- a0 H& _
  29.                 getInfo : function() {
    & f8 F8 o$ D" q8 `
  30.                         return {/ a1 N& B- I' D, Z1 Z. X
  31.                                 longname : "Recent Posts",
    5 |' ]" @1 ?' u
  32.                                 author : 'Specs'," `# W! _" l, M' C  @
  33.                                 authorurl : 'http://9iphp.com',1 }* [; e% }: p8 w
  34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    ' A  y* Q% G; A' g! u
  35.                                 version : "1.0"3 `% s6 _" w' }
  36.                         };& y4 O" J! O- ~
  37.                 }/ l9 G  n2 v( l  z) @9 w" E
  38.         });2 \* a5 d  i( V0 W# h
  39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);9 G0 c& T( e. }/ A
  40. })();
複製代碼
我們透過呼叫 tinymce.create() 建立了一個插件。代碼中最重要的是 init() 函數，我們定義了一個名字，一個icon文件及 onclick() 事件處理程序。
在 onclick() 函數的前兩行，依序彈出兩個對話框讓用戶輸入文章數量及列表標題兩個參數，然後根據用戶輸入，把短代碼插入到編輯器中。
最後，TinyMCE插件透過 add() 函數增加到 PluginManager。現在我們已經成功的整合了 [recent-posts] 短代碼到Wordpress中。
! g. L! W* {3 b# Q7 W3 z
4.2 註冊按鈕及TinyMCE插件
# c) P- \! I: ?  A' H2 l
) o. P: |- R5 D: n' s; t! c, ~6 Q* E
當您完成建立的JS 檔 , 我們現在需要註冊它和短代碼按鈕。 因此我們建立了兩個函數並把它們繫結至適當的 wordpress 過濾器中。
第一個叫做 register_button() 的函數把短代碼增加到按鈕陣列中，在現有按鈕和新按鈕之間增加分割線。
  1. function register_button( $buttons ) {2 S( c) |' c! y, u
  2.         array_push( $buttons, "|", "recentposts" );
    & c' |" P2 k8 _& V, u* A
  3.         return $buttons;9 i/ b8 P9 ?9 W* P
  4. }
複製代碼
第二個函數 add_plugin() 指定JS文件的路徑及文件名。* p2 |* H- w0 M' @9 C
  1. function add_plugin( $plugin_array ) {
    ; g+ A  T, I$ Q6 R. m, ^' c
  2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';4 V  L- E: d- y' P: U* g
  3.         return $plugin_array;$ b( P4 d# A: t' d1 T5 Z
  4. }
複製代碼
下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器，這個會在編輯器載入插件的時候執行； add_plugin() 函數連結到 mce_external_plugins 過濾器，當載入按鈕的時候執行。3 R& Q0 ~# u8 Y9 |9 O1 v" }& [
  1. function my_recent_posts_button() { / A' I4 q, H; b. k, z
  2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {+ s% J# W! l5 Y( `$ M
  3.                 return;
    ( s3 `" f2 a3 q( g4 D: b! {
  4.         }
    - k! f# f; s' i( f6 Q8 v  M( t( k& e

  5. + p0 q4 P: \4 F) g: Q# L' k
  6.         if ( get_user_option('rich_editing') == 'true' ) {
    ' z1 |  g, X+ {! s) D) P
  7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
    + X* g1 `: W2 J. H$ b
  8.                 add_filter( 'mce_buttons', 'register_button' );% ^" e8 H; A0 D, s- b, l$ f# @
  9.         }
    0 J; s. Z8 {/ j% A- u4 ~8 z
  10. }
複製代碼
當用戶沒有對文章可視化編輯器中編輯的權限時，前面的函數不會執行。
" X  w) W% `/ p最後把函數勾到Wordpress初始化函數
  1. add_action('init', 'my_recent_posts_button');
複製代碼
, z5 a9 E: I* q" J# [( F5 T' D
4.3 按鈕的用法
6 a1 r/ {- X5 {1 l- w$ m0 n
為了測試程式碼是否正確，我們打開一篇新的文章，這時一個我們剛剛定義的按鈕是不是已經出現在第一行的末尾了？如下圖所示：
7 ?# E; h, B  ~3 ~
點擊按鈕的時候，會彈出對話框讓我們輸入文章的數量：

6 y' C1 {1 F: |6 v# d8 D: B
輸入完點擊確定後，會彈出第二個對話框，讓我們輸入列表的標題：

6 d3 P% s3 I  o1 a/ w
參數留空的話，不會出現在最後的代碼中。最後，短代碼會新加到編輯器中：
3 z* W; E( I: e. [
到此就大功告成了。想要增加其他功能的短代碼及按鈕可以參考上面的教學，如法炮製舉一反三，相信可以製作出符合各位需求的短代碼功能。
參考文章: 1 2




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