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

 找回密碼
 立即註冊
查看: 1440|回復: 0

[wordpress] WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕[含4張圖]

[複製鏈接]
發表於 2016-6-9 12:40:16 | 顯示全部樓層 |閱讀模式
tid=39737&WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button), R/ A8 e9 U7 F6 q2 |3 H# i

$ d( I3 n! ^& \9 Z2 A! ?wordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入,用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容,短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時,透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。/ z, D* r  ?4 b1 F" J
以下是 wordpress 短代碼的詳细介紹及進階應用。8 \- o* ~# m+ e' g* i2 w3 E

; E9 Q% h9 ^4 B5 y, N+ J/ x6 Y短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :4 d: H1 f- P( }+ m" c0 z2 a0 ?
  1. [recent-posts]
複製代碼
此外 , 我們可以設定一個參數來控制文章的數量 :
6 U  O, E+ S5 Z. [  h, S6 H
  1. [recent-posts posts="5"]
複製代碼
此外 , 我們也可以為文章列表新增一個標題 :

5 h: ?4 c' `, X7 R
  1. [recent-posts posts="5"]Posts Heading[/recent-posts]
複製代碼

6 I) k0 A! L0 P+ V% {' y# x# q4 _

. ?- i* A- z. T2 I* k" V7 }1. 簡單的短代碼

( t: m& y# L! @0 m, T本教學的第一部分 , 我們會建立下列短代碼的程式碼 :8 T2 z8 ^! y" _; j6 N; o  {
  1. [recent-posts]
複製代碼
該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :
" H! e2 f/ [) q% ?  R( k1 [
  • 建立一個函數 , 當 wordpress發現短代碼時會呼叫此函數 ;
  • 藉由設置一個唯一的名稱來註冊短代碼 ;
  • 把註冊的函數連結到wordpress的action上
    ( x5 K1 e. v0 z- E. k

+ W0 l$ U& [% O, ]) x
本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。
1 P8 q/ S1 p6 q: l3 b6 i+ x
1.1 建立返回函數, W. y- d3 Z7 ^3 `+ C/ z2 q! i1 @
當發現短代碼的時候,它會被一個稱作返回函數的一段代碼所代替,所以我們先建立一個函數,從資料庫中獲取最新的文章。
! b1 N, ^, E: V6 H' |4 c
  1. function recent_posts_function() {1 P# ^2 d7 b6 ]
  2.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));2 `3 p; L7 G  D2 _# J" U
  3.         if (have_posts()) :9 a8 Y; j) c) R7 K( Q) Z2 N6 L9 d
  4.                 while (have_posts()) : the_post();
    / }6 W2 V! |8 g
  5.                         $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';# t; E1 S; b3 N* R+ h/ y
  6.                 endwhile;
    3 J3 t7 r. x6 }' {( I
  7.         endif;7 O4 G3 K5 ?7 ~- X
  8.         wp_reset_query();, p$ M( z7 U6 k$ x& |, G- J
  9.         return $return_string;( J1 e9 {9 A- ^5 S  I) j
  10. }
複製代碼
如上所示,我們查詢資料庫,獲取最新的文章,並返回一個帶有鏈接的字串。值得註意的是,返回函數並不印任何內容,而是返回一個字串。

# ^2 w7 X: ]( R- X
, ^! b% \6 m, Y

% m( C: f) G4 H' B# T1.2 註册短代碼# u/ l5 [; `$ ^* [$ ]2 n* H# O: R
現在,我們告訴Wordpress這個函數是一個短代碼:
  1. function register_shortcodes(){
    2 t$ t" H# O  \3 y/ W' v5 e
  2.         add_shortcode('recent-posts', 'recent_posts_function');
    $ T: C0 m. ]* r0 E. }' S
  3. }
複製代碼
當在文章的內容中使用短代碼, w! P, y, T3 B" g
  1. [recent-posts]
複製代碼
將會自動呼叫 recent_posts_function() 函數,我們需要確保短代碼的名字是唯一的,以避免重複。

' f) N* l6 n8 N# H# a
2 N: ]7 G4 J/ v2 k
& k* Y  j* W0 N2 l
1.3 Hook into WordPress9 Z' u* T/ {8 L
  G8 ?5 R# J$ Z& h4 S3 Y7 S
為了能夠執行 recent_posts_function() 函數,我們需要把它綁定在 WordPress 的初始化鉤子中。! s% r2 s# q) {% q
  1. add_action( 'init', 'register_shortcodes');
複製代碼
; k& B, S/ M4 w/ b) w6 g4 N- D8 k
1.4 測試短代碼

$ p' D9 G5 g9 m" E, ]( _$ d簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :
  1. [recent-posts]
複製代碼
2. 進階短代碼
2.1 短代碼参數
短代碼是非常有彈性 , 因為它讓我們加入參數可讓它們有更多的功能。 假設我們必須要顯示某一特定數量的最新的文章。 為了達到這個目的 , 我們需要給短代碼指定其他選項以顯示最近的文章數。
我們需要使用兩個函數 ,第一個是內建在 wordpress 的shortcode _ atts ( ) 函式 , 它把用戶的短代碼屬性與本地屬性結合在一起 , 並填入到想要的位置。 第二個是 PHP的extract() 函数 , 顧名思義 , 它萃取出短代碼中的各個屬性。
展開我們的返回功能 , 我們新增一個參數 $atts, 它是一個陣列,從中可以提取到我們需要的文章數。 我們查詢資料庫來取得指定數目的文章 , 並傳回一個列表 :
  1. function recent_posts_function($atts){
    $ U2 u9 ~% X. Q* ]5 I* a
  2.         extract(shortcode_atts(array(4 U* G/ V# j# k5 s& Q! s* a
  3.                 'posts' => 1,& @) R: G* J- l2 h1 N
  4.         ), $atts));% u. q- G! x" L7 v" _

  5. 0 x3 Z5 \0 p4 p8 S
  6.         $return_string = '<ul>';
    7 e; f1 K. B  o7 s
  7.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));8 V: R# [0 k0 n5 B% E- d
  8.         if (have_posts()) :" E3 Q. m6 T5 n7 [% r
  9.                 while (have_posts()) : the_post();
    % Z; U0 U. j9 b$ `+ |( D- t
  10.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';: i6 [* [- Z, y
  11.                 endwhile;
    - i0 n* H* o, G0 B% Y
  12.         endif;  a+ t3 S5 d' F' R- M' i+ i6 c) s
  13.         $return_string .= '</ul>';& i8 m+ J( H, r0 B2 C6 u0 ?$ ^

  14. 4 f- Z# n+ q8 b) H) T' w/ i
  15.         wp_reset_query();* j. y' h. b$ E$ k
  16.         return $return_string;) Z; S: _' y' I: G6 G
  17. }
複製代碼
如果使用者未指定此選項 , 1 將是預設值。 我們可以加入多個屬性使短代碼接受更多的參數。 使用這項強化函數 , 我們就可以指定調用最新文章的數量 :
  1. [recent-posts posts="5"]
複製代碼
當顯示於瀏覽器 , 您就可以看到最近的五篇文章列表

6 H9 U$ J8 g) O9 ~" s& ^
2.2 短代碼中增加内容
我們可以繼續擴展我們的短代碼、新增一些內容作為參數 來傳遞, 例如"最新文章列表的標題"。 若要達成此目的 , 我們需要在返回函數中新增第二個參數$content , 並把它顯示在列表前面的一個 <h3> 標簽中。新的函數如下:
  1. function recent_posts_function($atts, $content = null) {  q* }7 h' U/ T0 t. Z
  2.         extract(shortcode_atts(array(- Z$ C" l8 m# ?1 N+ e( o  z3 b
  3.                 'posts' => 1,1 n" T& R9 v/ f2 Q! G
  4.         ), $atts));
    / q" Y" G2 u! }* ^# U
  5. 4 H, |8 a3 @1 L4 B
  6.         $return_string = '<h3>'.$content.'</h3>';
    " {# d; C0 s: n- j' W4 W
  7.         $return_string .= '<ul>';- v- `* t  X$ `/ J
  8.         query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
    / P& r) {( i9 w$ C7 p1 }
  9.         if (have_posts()) :* [5 }! o! x$ S$ C8 m1 B
  10.                 while (have_posts()) : the_post();
    : X. L" k0 s; Q5 @' b% N& [* X2 p
  11.                         $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
    5 U, X+ q& z& h  ~/ x
  12.                 endwhile;7 B5 b. ~# u* f  S/ @
  13.         endif;. M: q: h1 m/ N) E5 c* N' V1 s+ `
  14.         $return_string .= '</ul>';. p( I1 x- j7 S" b' l8 W# u5 d; A

  15. 7 B& _+ w$ P! r) E! P/ `+ R/ {
  16.         wp_reset_query();
    & x6 t+ p- m4 W( v! ~
  17.         return $return_string;
    ' H2 W* m0 X. t) F8 J1 Q
  18. }
複製代碼
這種短代碼類似於一個HTML標簽:
  1. [recent-posts posts="5"]This is the list heading[/recent-posts]
複製代碼
除了文章列表多了一個標題,其餘的內容和上一個示例是一樣的:
( J. W: O" t& i8 v/ V3 V( W9 Y
3. 在任何地方顯示短代碼
3.1 在側邊攔小工具中使用短代碼
預設情況下 , 側邊欄小工具是忽略短代碼的您可以將此程式碼放在小工具

, [  s# O  Y2 f/ U& s
我們可以採用一行程式碼來啟用這個函數 , 為了使側邊欄小工具支援短代碼 , 新增以下的程式碼 :
  1. add_filter('widget_text', 'do_shortcode');
複製代碼
現在不需要修改任何其他地方
, 刷新頁面, 側邊欄將會正確地顯示

* Z- h' i8 G9 w
同樣的,在評論中啟用短代碼:
  1. add_filter( 'comment_text', 'do_shortcode' );
複製代碼
在摘要中啟用短代碼:
  1. add_filter( 'the_excerpt', 'do_shortcode');
複製代碼
4. TinyMCE編輯器增加短代碼按鈕
: l$ T2 ~7 `- ~
0 s( ?- R# E: E5 }雖然短代碼可以方便的為文章增加動態內容,但是這對於普通用戶來說可能還是有點複雜,尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉,然而要使用短代碼,他們必須記住具體的語法與參數,因為即使是一個小小的語法錯誤,都可能導致意想不到的結果。
要解決這個,我們可以給 TinyMCE編輯器增加一個按鈕,使用戶可以透過簡單的點擊來增加短代碼。建立這個按鈕僅需兩個步驟:
  • 為此按鈕建立一個 JS 檔案
  • 註冊按鈕與JS文件% W: L5 y4 Q; Z4 [/ ?1 Y, `

5 ?4 D: _0 L3 w( b2 E3 d
4.1 透過JS文件來建立按鈕
JS文件是透過 TinyMCE API 來註冊 TinyMCE 插件的。我們在主題的 js 目錄下(/wp-content/themes/你主題名稱/js/)建立 recent-posts.js ,並貼進去下面的代碼(需要把按鈕圖片檔(/wp-content/themes/你主題名稱/js/recentpostsbutton.png)也放在同一個目錄):
  1. (function() {
    + D8 j" o, L( Y. l: N0 {. q
  2.         tinymce.create('tinymce.plugins.recentposts', {
      ^: i9 s$ v7 L( E1 U/ u
  3.                 init : function(ed, url) {
    + H2 `& Z. v- k" N) K. |7 k- P, L
  4.                         ed.addButton('recentposts', {% |6 r* o/ k" Y; j
  5.                                 title : 'Recent posts',
    6 {7 n( A3 |" j
  6.                                 image : url+'/recentpostsbutton.png',
    + ~3 r( s" L- u- n; V8 F9 M# q2 C
  7.                                 onclick : function() {7 {* N* D. K% o7 z( b1 C
  8.                                         var posts = prompt("文章數量", "1");
    2 D- g1 P. h& D5 F1 b) _: e: Y
  9.                                         var text = prompt("請填入列表標題", "最新文章");6 g- K* \  @0 q, y' [
  10. & q+ w/ @" c0 r2 \; g( M
  11.                                         if (text != null && text != ''){  y. @* F1 y3 `  e! t
  12.                                                 if (posts != null && posts != '')% D1 h; D6 M0 @
  13.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]');
    " |! \' u1 @0 K8 _8 E
  14.                                         else! S8 ~8 v& T4 n% U9 B6 [1 M
  15.                                                 ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');4 [  _5 m7 N$ Y7 y( R
  16.                                         }
    # o7 g( c3 S: x  p5 @. B/ ^8 o$ I
  17.                                         else{9 b( W( B+ a) P/ y
  18.                                                 if (posts != null && posts != '')/ n( x* t  ~9 l" `
  19.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
    5 i( N$ M4 i9 ?+ C# G
  20.                                                 else1 p7 a5 e; A# X8 y7 i
  21.                                                         ed.execCommand('mceInsertContent', false, '[recent-posts]');
    ) l- h# ~* b6 X) M# o- o, h
  22.                                         }. @/ ]7 r: l  \) X2 m
  23.                                 }
    5 u4 U  P, T: ~* B
  24.                         });" ^3 r5 R& r6 Y& k# Q
  25.                 },' Y- \5 W6 t3 D- t
  26.                 createControl : function(n, cm) {
    3 v3 h3 b8 T- a8 E# y5 A
  27.                         return null;; {7 l/ q/ q+ y1 f3 P
  28.                 },, `5 O( g$ _& s; ?0 e. B. G
  29.                 getInfo : function() {, H) m2 D2 l. z; x' d9 L
  30.                         return {. v$ i0 l4 n/ Q/ e3 w  ~
  31.                                 longname : "Recent Posts",
    % C: x- ^3 U# R3 d& V" Q5 G
  32.                                 author : 'Specs',. n2 ~3 x4 K8 p) u
  33.                                 authorurl : 'http://9iphp.com',
    ; ?9 h- j- `3 D+ v- {
  34.                                 infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',
    ) E+ P# w+ ?, W5 g# Z
  35.                                 version : "1.0"$ Q6 M1 t/ j4 k$ h- y
  36.                         };  b+ G8 ^$ Q. y* L; `% W3 r
  37.                 }0 Z6 X" H. T0 q2 _* w
  38.         });- m8 \+ z' X6 \& `; W1 O4 n9 j
  39.         tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
    4 _5 _: M, _, k
  40. })();
複製代碼
我們透過呼叫 tinymce.create() 建立了一個插件。代碼中最重要的是 init() 函數,我們定義了一個名字,一個icon文件及 onclick() 事件處理程序。
在 onclick() 函數的前兩行,依序彈出兩個對話框讓用戶輸入文章數量及列表標題兩個參數,然後根據用戶輸入,把短代碼插入到編輯器中。
最後,TinyMCE插件透過 add() 函數增加到 PluginManager。現在我們已經成功的整合了 [recent-posts] 短代碼到Wordpress中。

, h1 u( L6 s" q: m1 H  d' _& H5 B
4.2 註冊按鈕及TinyMCE插件
) V: K! ^% F7 B( Z& a5 K. `2 l6 W
8 w5 X) ]) Y" M4 r
當您完成建立的JS 檔 , 我們現在需要註冊它和短代碼按鈕。 因此我們建立了兩個函數並把它們繫結至適當的 wordpress 過濾器中。
第一個叫做 register_button() 的函數把短代碼增加到按鈕陣列中,在現有按鈕和新按鈕之間增加分割線。
  1. function register_button( $buttons ) {5 I3 ?& p5 |. B# ?
  2.         array_push( $buttons, "|", "recentposts" );7 `* D( k  W# ^; i: a; X
  3.         return $buttons;
    7 J. w# c: B  F9 |- s4 c! E* C
  4. }
複製代碼
第二個函數 add_plugin() 指定JS文件的路徑及文件名。: v# o" K! t6 Z# v- U
  1. function add_plugin( $plugin_array ) {
    7 V9 o! ?& ]5 D) ~
  2.         $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';  A4 h: t0 f$ ?
  3.         return $plugin_array;: ]( F8 L( U# R6 o; q: \* j
  4. }
複製代碼
下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器,這個會在編輯器載入插件的時候執行; add_plugin() 函數連結到 mce_external_plugins 過濾器,當載入按鈕的時候執行。4 g. e5 Z3 l% x* H) C
  1. function my_recent_posts_button() {
    : T2 R0 }/ I' r
  2.         if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {8 i" |1 _) T, E% B7 @
  3.                 return;! f  ]! d! B4 n
  4.         }0 D- n! i$ L+ r4 z+ x

  5. + L1 R+ g6 Z* Y7 h0 J
  6.         if ( get_user_option('rich_editing') == 'true' ) {) S' H& j: |0 J) q: s3 @8 f
  7.                 add_filter( 'mce_external_plugins', 'add_plugin' );
    9 i9 f2 c$ j3 |; k, N5 c% \
  8.                 add_filter( 'mce_buttons', 'register_button' );7 ?* Q# Z$ b0 e3 F
  9.         }
    3 P4 N) @2 F0 b4 w7 i! A1 V5 s9 T
  10. }
複製代碼
當用戶沒有對文章可視化編輯器中編輯的權限時,前面的函數不會執行。
5 Z! H! y9 L7 A4 l5 P最後把函數勾到Wordpress初始化函數
  1. add_action('init', 'my_recent_posts_button');
複製代碼
- F) I9 x3 V. L" C; Y: F! e6 N
4.3 按鈕的用法

7 m8 i( @. I# u5 v/ Q: `7 U9 l
為了測試程式碼是否正確,我們打開一篇新的文章,這時一個我們剛剛定義的按鈕是不是已經出現在第一行的末尾了?如下圖所示:
52av-1.png ' Y% T* }1 T" o6 d
點擊按鈕的時候,會彈出對話框讓我們輸入文章的數量:
52av-2.png : T$ S4 M5 G1 n4 E( |
輸入完點擊確定後,會彈出第二個對話框,讓我們輸入列表的標題:
52av-3.png
0 ]7 z, ^( S( O0 f  V9 _. d7 ^
參數留空的話,不會出現在最後的代碼中。最後,短代碼會新加到編輯器中:
52av-4.png ; U8 @$ W1 |$ _/ X
到此就大功告成了。想要增加其他功能的短代碼及按鈕可以參考上面的教學,如法炮製舉一反三,相信可以製作出符合各位需求的短代碼功能
參考文章: 1 2
回復

使用道具 舉報

您需要登錄後才可以回帖 登錄 | 立即註冊

本版積分規則



中文酷站排行榜

本區塊內容依據『電腦網路內容分級處理辦法』為限制級網站,限定年滿18歲以上或達當地國家法定年齡人士方可進入,且願接受本站各項條款,未滿18歲 謝絕進入瀏覽。為防範未滿18歲之未成年網友瀏覽網路上限制級內容的圖文資訊,建議您可進行網路內容分級組織ICRA分級服務的安裝與設定。 (為還給愛護 本站的網友一個純淨的論壇環境,本站設有管理員)

QQ|小黑屋|手機板| 52AV手機A片王

GMT+8, 2024-12-25 15:15 , Processed in 0.078780 second(s), 20 queries .

Powered by Discuz! X3.4

Copyright © 2001-2021, Tencent Cloud.

快速回復 返回頂部 返回列表