tid=39737&WordPress自定義短代碼Shortcode以及產生編輯器短代碼按鈕(shortcode button)) ~' ?: G! h( W) I1 k; `
0 u( @9 @! h" I4 M( T8 P- hwordpress Shortcode即wordpress短代碼功能是在wordpress 2.5版本開始被引入,用户透過wordpress短代碼可以非常方便快速地在編輯文章或頁面的時候插入動態内容,短代碼的常見應用有插入最新文章、插入廣告、插入音樂視訊、插入下載按钮等。Blog請别人制作wordpress模板時,透過wordpress Shortcode實現了page頁面動態插入不同的幻灯片。
. y4 s" @; K2 x ?以下是 wordpress 短代碼的詳细介紹及進階應用。& C/ I3 d1 U z @1 f U
1 I R9 y& O' p: r% V% e, h
短代碼的 wordpress 使用非常簡單。 例如我們想要顯示為指定最近的文章 , 我們可以使用的程式碼類似於下列 :
" N; B" V' `4 k6 d此外 , 我們可以設定一個參數來控制文章的數量 :
" I" @) U% l% p/ s* m' n此外 , 我們也可以為文章列表新增一個標題 :
) C9 `- H' J3 V' ]3 I- [recent-posts posts="5"]Posts Heading[/recent-posts]
複製代碼 2 m; c6 [ `/ u2 P$ D* _
5 {7 a$ q Z0 F) D: C; {
1. 簡單的短代碼
8 q( b0 e v: W! B& m& R: ~本教學的第一部分 , 我們會建立下列短代碼的程式碼 :
& a( c3 S1 V) I" J該程序的建立是非常簡單並且不需要非常進階 PHP 知識。 建立過程如下 :* {/ W* }7 Z3 I
- 建立一個函數 , 當 wordpress發現短代碼時會呼叫此函數 ;
- 藉由設置一個唯一的名稱來註冊短代碼 ;
- 把註冊的函數連結到wordpress的action上。& u) H p, k7 f* z& K3 z M) W
! W% x( U/ ]) U% ^) o/ E1 C8 T4 k
本教學所有程式碼將會直接放到function.php(控制台==>外觀==>主題編輯器==>function.php) ,也可以放在一個被包含在function.php的單獨的php檔案中。% P6 l5 M- V+ d$ b
1.1 建立返回函數+ J9 c: R) X2 I5 E' g
當發現短代碼的時候,它會被一個稱作返回函數的一段代碼所代替,所以我們先建立一個函數,從資料庫中獲取最新的文章。
. w* t# Z) H+ P3 X- ?& L- function recent_posts_function() {
0 D4 D+ Z }' C+ ~% Y" C - query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => 1));
3 W5 i( d: C0 P! L* r; o - if (have_posts()) :
, x: E1 R% F4 n - while (have_posts()) : the_post();7 S- b* n8 p0 V: Z
- $return_string = '<a href="'.get_permalink().'">'.get_the_title().'</a>';% w# _, c: R% S2 S
- endwhile;
, b4 `' C! b" ` q; ?( k! F! v# i, b - endif;
6 ~ a! S V$ Z( I6 ?/ _ - wp_reset_query();* E( T# n$ U2 B6 w; g
- return $return_string;
, |5 {" ?4 n2 s( `4 R6 q - }
複製代碼 如上所示,我們查詢資料庫,獲取最新的文章,並返回一個帶有鏈接的字串。值得註意的是,返回函數並不印任何內容,而是返回一個字串。2 N; p. ~! }; [4 O6 J' l; B0 {
; V! I, d' A$ h
: b) {8 |5 S* ?+ J1.2 註册短代碼
% U0 n0 h% y! h- Y: R) @, b現在,我們告訴Wordpress這個函數是一個短代碼:- function register_shortcodes(){- N1 e2 C) i$ Z/ B! C% X; _6 i# H
- add_shortcode('recent-posts', 'recent_posts_function');% l8 o3 I3 J3 n4 r; ~- f# _0 r
- }
複製代碼 當在文章的內容中使用短代碼
# L- ?& @1 [, W8 e/ W將會自動呼叫 recent_posts_function() 函數,我們需要確保短代碼的名字是唯一的,以避免重複。
6 S {( }. a) e* P3 y4 X R' R5 ~" A) [" I: n- x
' f8 {5 t" e9 \4 o: {8 Z' a1.3 Hook into WordPress4 x6 e% J: `( p$ s& V& ?! \# D9 O0 ^) W9 c
3 t0 o. {0 ~0 e- `6 z( N5 Y# C- ~/ d
為了能夠執行 recent_posts_function() 函數,我們需要把它綁定在 WordPress 的初始化鉤子中。
0 R4 K4 `7 e" E* y# {5 x- add_action( 'init', 'register_shortcodes');
複製代碼
# f; l$ [8 |2 k1.4 測試短代碼
# A4 V1 l& s: C8 Z簡單的短代碼已設定 , 我們現在需要測試是否能正常執行。 我們可以建立新文章 ( 或開啟現有 ) , 將下列代碼加到文章內容的某個位置 :2. 進階短代碼 2.1 短代碼参數 短代碼是非常有彈性 , 因為它讓我們加入參數可讓它們有更多的功能。 假設我們必須要顯示某一特定數量的最新的文章。 為了達到這個目的 , 我們需要給短代碼指定其他選項以顯示最近的文章數。 我們需要使用兩個函數 ,第一個是內建在 wordpress 的shortcode _ atts ( ) 函式 , 它把用戶的短代碼屬性與本地屬性結合在一起 , 並填入到想要的位置。 第二個是 PHP的extract() 函数 , 顧名思義 , 它萃取出短代碼中的各個屬性。 展開我們的返回功能 , 我們新增一個參數 $atts, 它是一個陣列,從中可以提取到我們需要的文章數。 我們查詢資料庫來取得指定數目的文章 , 並傳回一個列表 : - function recent_posts_function($atts){. c7 [+ X1 L- e/ ^
- extract(shortcode_atts(array(* A; g9 O0 H) r+ f
- 'posts' => 1,0 Y( H: k# e1 E1 ~/ Y/ S; Q) Z
- ), $atts));
* W& U% n" p! c5 P - 6 Z, p( W" D) A7 l# y6 @, x
- $return_string = '<ul>';
; V4 j! R6 ~) P5 p6 e( k, Y - query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));5 j" R. T) P9 ~* P c* }' P
- if (have_posts()) :
' o* f1 M8 w1 a2 S0 R' E - while (have_posts()) : the_post();* C2 `/ K& J2 m: y; m
- $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
! r9 k$ `6 S1 O0 m2 V) {2 I+ I7 ` - endwhile;
; D8 ^7 D1 v y( ? - endif;
7 O0 N) T2 x c" y; x) p7 Q - $return_string .= '</ul>';; ~% P- e2 z3 n# O9 l7 r, ~
- . A6 x# ?- b8 {2 T8 z' ^3 @* G
- wp_reset_query();$ j% T* H4 ]' v6 x' r
- return $return_string;3 u z2 R7 f, [+ e+ {) R
- }
複製代碼 如果使用者未指定此選項 , 1 將是預設值。 我們可以加入多個屬性使短代碼接受更多的參數。 使用這項強化函數 , 我們就可以指定調用最新文章的數量 :當顯示於瀏覽器 , 您就可以看到最近的五篇文章列表 ) ^# ?6 X) ^5 i. K, f n
2.2 短代碼中增加内容 我們可以繼續擴展我們的短代碼、新增一些內容作為參數 來傳遞, 例如"最新文章列表的標題"。 若要達成此目的 , 我們需要在返回函數中新增第二個參數$content , 並把它顯示在列表前面的一個 <h3> 標簽中。新的函數如下: - function recent_posts_function($atts, $content = null) {# ^. }/ Z4 w8 |+ a! u7 o) q8 w
- extract(shortcode_atts(array(% b9 j. J0 g) p
- 'posts' => 1,. [ Y3 f1 g. ^ K8 Z7 u
- ), $atts));
* p) I& B6 O/ s# n# | -
+ b; r/ K- n& Z' b. y - $return_string = '<h3>'.$content.'</h3>'; X* G0 o7 i; s3 {9 [( x: q
- $return_string .= '<ul>';. Q( T1 A' P1 V6 C6 e0 o- S$ Y
- query_posts(array('orderby' => 'date', 'order' => 'DESC' , 'showposts' => $posts));
+ X. [% T( | @% X' j3 @* Y - if (have_posts()) :
% v j7 B( g2 K) W! ]& P! n - while (have_posts()) : the_post();6 V) @$ C- v4 I) j- u
- $return_string .= '<li><a href="'.get_permalink().'">'.get_the_title().'</a></li>';
& R. n3 t+ Z+ g4 T, f$ r - endwhile;
( v1 G" X6 a* K" c. S# d - endif;
- D0 D' W7 f' D" B - $return_string .= '</ul>';2 F) z' |( H/ O
-
$ g/ R0 u; ^3 l4 s& w) i, U2 P - wp_reset_query();! Y$ i& [* D% R6 F3 M
- return $return_string;
/ N) B+ g# A8 O - }
複製代碼 這種短代碼類似於一個HTML標簽:- [recent-posts posts="5"]This is the list heading[/recent-posts]
複製代碼 除了文章列表多了一個標題,其餘的內容和上一個示例是一樣的:
2 F1 |6 x& K0 S3 S: A; z Q3. 在任何地方顯示短代碼 3.1 在側邊攔小工具中使用短代碼 預設情況下 , 側邊欄小工具是忽略短代碼的,您可以將此程式碼放在小工具 }% \+ R2 V1 e3 M9 V
我們可以採用一行程式碼來啟用這個函數 , 為了使側邊欄小工具支援短代碼 , 新增以下的程式碼 : - add_filter('widget_text', 'do_shortcode');
複製代碼 現在不需要修改任何其他地方 , 刷新頁面, 側邊欄將會正確地顯示
5 [ R7 @; T, S, g! @2 p3 {1 X同樣的,在評論中啟用短代碼: - add_filter( 'comment_text', 'do_shortcode' );
複製代碼 在摘要中啟用短代碼:- add_filter( 'the_excerpt', 'do_shortcode');
複製代碼 4. TinyMCE編輯器增加短代碼按鈕
q' T5 s ^% ^( C0 F% u$ x i) q/ b8 X8 I* x% n4 d4 |
雖然短代碼可以方便的為文章增加動態內容,但是這對於普通用戶來說可能還是有點複雜,尤其是當參數比較多的時候。大多數用戶對於類HTML代碼並不熟悉,然而要使用短代碼,他們必須記住具體的語法與參數,因為即使是一個小小的語法錯誤,都可能導致意想不到的結果。要解決這個,我們可以給 TinyMCE編輯器增加一個按鈕,使用戶可以透過簡單的點擊來增加短代碼。建立這個按鈕僅需兩個步驟: - 為此按鈕建立一個 JS 檔案
- 註冊按鈕與JS文件
+ i+ N4 W! z( S8 R$ c" K 4 Q% d" z& Q% R6 p7 N
4.1 透過JS文件來建立按鈕JS文件是透過 TinyMCE API 來註冊 TinyMCE 插件的。我們在主題的 js 目錄下(/wp-content/themes/你主題名稱/js/)建立 recent-posts.js ,並貼進去下面的代碼(需要把按鈕圖片檔(/wp-content/themes/你主題名稱/js/recentpostsbutton.png)也放在同一個目錄): - (function() {
0 e" r6 s& F, z: m9 {3 ~ - tinymce.create('tinymce.plugins.recentposts', {: |4 u; M- ]. s4 F6 o
- init : function(ed, url) {2 w+ d1 V+ _& E* @0 v' V/ F
- ed.addButton('recentposts', {7 U4 I& }) t- y9 z
- title : 'Recent posts',
- t* b d2 @9 o1 i - image : url+'/recentpostsbutton.png',
2 m6 E0 z- q3 _ - onclick : function() {
6 z' U6 i3 ?3 z3 @$ s - var posts = prompt("文章數量", "1");
' `) S' H, ]+ _, h- N* x5 M - var text = prompt("請填入列表標題", "最新文章");
2 L* p8 l7 D$ M g' S8 P9 H0 B - 9 Z. C3 y5 o- y, f: c8 U( n
- if (text != null && text != ''){- x3 }% Y4 P5 ]2 y# M z
- if (posts != null && posts != '')7 t1 I/ q2 U" G* w' H! K
- ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]'+text+'[/recent-posts]'); V# \$ H( g2 Z+ z3 h
- else
4 E3 ~4 E5 m( `: i - ed.execCommand('mceInsertContent', false, '[recent-posts]'+text+'[/recent-posts]');
( h5 H' N* r$ T ?0 P \, Y1 t - }- a1 D+ I# j9 a5 d, K/ t; |. t
- else{* W& I R* |6 A( k: V4 _
- if (posts != null && posts != '')) L' m/ ~5 e& a" R
- ed.execCommand('mceInsertContent', false, '[recent-posts posts="'+posts+'"]');
$ N# _' w' g" V" ^8 b - else7 [$ T9 t& _. [: R% F. R1 A
- ed.execCommand('mceInsertContent', false, '[recent-posts]');3 z+ I; n$ M2 ?+ _9 U/ A. y" x
- }
# C! B1 o: r7 s" a& P$ T4 j0 { - }, {9 T; j) h3 w, C) Q
- });& U# S5 b' B2 w# y2 ]/ @9 x3 D
- },8 \; k7 l( X0 i8 H5 {
- createControl : function(n, cm) {
$ `1 Z* \ J) P& G/ c( L# ? - return null;; D# ~/ z% u/ M5 u) n' v( O
- },
- A" |1 M. w0 q3 E1 W - getInfo : function() {
" ]+ f- B7 H9 K( @ y' F2 W7 \ - return {, p, I2 ?" S+ @- |! i
- longname : "Recent Posts",
- W- x! l9 n" ?( B# A7 s! W. ?7 o5 t- Y - author : 'Specs',- M" _% c6 e/ B3 V9 i5 ~! l
- authorurl : 'http://9iphp.com',
& _% H& M6 X6 l/ x- ?& x5 M/ k& _ - infourl : 'http://9iphp.com/opensystem/wordpress/1094.html',1 V; f Q4 ?% }# r/ f& u
- version : "1.0"
+ F7 y" D2 {/ P9 n- k$ _, Q0 | - };
5 {- \) X' x+ ] - }
" R( j" o9 ^( f# ~ - });
$ r# ~, O" y$ K2 _- Y9 V4 N - tinymce.PluginManager.add('recentposts', tinymce.plugins.recentposts);
/ z1 W5 y$ l! a" W! s3 { L - })();
複製代碼 我們透過呼叫 tinymce.create() 建立了一個插件。代碼中最重要的是 init() 函數,我們定義了一個名字,一個icon文件及 onclick() 事件處理程序。在 onclick() 函數的前兩行,依序彈出兩個對話框讓用戶輸入文章數量及列表標題兩個參數,然後根據用戶輸入,把短代碼插入到編輯器中。 最後,TinyMCE插件透過 add() 函數增加到 PluginManager。現在我們已經成功的整合了 [recent-posts] 短代碼到Wordpress中。
+ _4 Y& P! \# o( H x" I
4.2 註冊按鈕及TinyMCE插件
( ]5 R$ u6 X4 U6 Y( i' F6 `% u! M7 B5 t/ M9 H
當您完成建立的JS 檔 , 我們現在需要註冊它和短代碼按鈕。 因此我們建立了兩個函數並把它們繫結至適當的 wordpress 過濾器中。 第一個叫做 register_button() 的函數把短代碼增加到按鈕陣列中,在現有按鈕和新按鈕之間增加分割線。 - function register_button( $buttons ) {
* ^4 r4 J! H9 _3 t- s6 x: F: G - array_push( $buttons, "|", "recentposts" );
h- T! `* Z9 Z - return $buttons;
0 [, [5 N+ Y, ^3 E" r$ O+ ^ - }
複製代碼 第二個函數 add_plugin() 指定JS文件的路徑及文件名。$ f8 \; m: M. l( t: ^$ x" A
- function add_plugin( $plugin_array ) {$ g0 y3 B/ {1 M4 L* q6 X; ]1 F
- $plugin_array['recentposts'] = get_template_directory_uri() . '/js/recent-posts.js';
2 s0 _9 V$ x; u. m1 P - return $plugin_array;
' \" d( W+ A/ O' C& Z - }
複製代碼 下一步是增加包含前面兩個函數的過濾器。register_button() 函數連結到 mce_buttons 過濾器,這個會在編輯器載入插件的時候執行; add_plugin() 函數連結到 mce_external_plugins 過濾器,當載入按鈕的時候執行。
8 N9 b; y( [$ p( K& B' ~- E: z2 R6 {- function my_recent_posts_button() {
5 g* D. k6 {/ s0 o# D - if ( ! current_user_can('edit_posts') && ! current_user_can('edit_pages') ) {% l5 C6 d# u7 I3 T+ ^) Y
- return;$ s, d7 d1 M+ l& E
- }
, c2 z, W/ U" w c -
1 U { f S; g0 Y9 ?7 {0 u - if ( get_user_option('rich_editing') == 'true' ) {: m/ A2 [& h; h" h$ P7 |4 u
- add_filter( 'mce_external_plugins', 'add_plugin' );
! X6 }9 f7 j( d% t - add_filter( 'mce_buttons', 'register_button' ); ^& E/ H0 E2 e9 x, w+ S3 Y5 Y# g& y
- }
3 `. v0 N$ M! B# X4 G/ O - }
複製代碼 當用戶沒有對文章可視化編輯器中編輯的權限時,前面的函數不會執行。
3 ]5 A0 ]! |2 C最後把函數勾到Wordpress初始化函數- add_action('init', 'my_recent_posts_button');
複製代碼
& V7 a) m- k# V% C% b5 Q4.3 按鈕的用法
% X6 }+ H/ H5 O/ X' @
為了測試程式碼是否正確,我們打開一篇新的文章,這時一個我們剛剛定義的按鈕是不是已經出現在第一行的末尾了?如下圖所示:
5 H" {8 K- S8 M
點擊按鈕的時候,會彈出對話框讓我們輸入文章的數量:
* H3 R8 t+ Y" p0 |2 ~$ |7 Z
輸入完點擊確定後,會彈出第二個對話框,讓我們輸入列表的標題:
* \# ~4 H j' B( ^ 參數留空的話,不會出現在最後的代碼中。最後,短代碼會新加到編輯器中:
, W" T w* c3 `3 y 到此就大功告成了。想要增加其他功能的短代碼及按鈕可以參考上面的教學,如法炮製舉一反三,相信可以製作出符合各位需求的短代碼功能。 |