WordPress 的插件機制實際上只的就是這個 Hook 了,它中文被翻譯成鉤子,允許你參與 WordPress 核心的運行,是一個非常棒的東西,下面我們來詳細了解一下它。
鉤子分類
鉤子分為兩種,一種叫做動作(action),還有一種叫做過濾器(filter)。這兩種鉤子實現原理基本一樣,後邊會講到,使用上的區別在於過濾器有返回值,而動作沒有。
動作的理念是讓你在一種情況或者一個特別的位置執行一些函數,比如發送一封郵件等;過濾器則是讓你修改 WordPress 核心需要用到的一個值,然後 WordPress 再用這些值做一些事情,比如函數的返回值等。
動作鉤子
wp_head 是一個很常用的動作鉤子,在開發主題過程中,開發者都會在 head 標簽裡加上 wp_head() 函數,事實上,正是這個函數調用了 wp_head 鉤子。
如果插件開發者想要在 head 標簽裡添加一句話,就可以使用 wp_head 鉤子,下邊是個簡單的例子。
//在 head 標簽添加一些內容 function Bing_add_head_tag(){ echo '添加內容'; } add_action( 'wp_head', 'Bing_add_head_tag' );
添加代碼後,查看前台的網頁源代碼,就能在 head 標簽裡看到我們添加的內容了。
上邊是一個簡單的例子,只是打印了一句話。利用這個鉤子,我們還可以做一個遇到 404 頁面給管理員發送一封郵件的插件,下邊簡單的寫了一個。
//遇到 404 頁面給管理員發送郵件 function Bing_404_page_mail(){ if( !is_404() ) return;//如果不是 404 頁面就退出函數 $to = get_option( 'admin_email' );//獲取管理員地址 $subject = '遇到 404 頁面啦!';//郵件標題 $message = '404 頁面的地址:http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];//郵件內容 wp_mail( $to, $subject, $message );//發送郵件 } add_action( 'wp_head', 'Bing_404_page_mail' );
過濾器鉤子
根據我的親身經歷,可能過濾器鉤子會難理解些,尤其對不熟悉 PHP 的人來說。
過濾器鉤子可以讓你改一些東西的值,過濾器回調函數會接受一個參數,這就是當前的值。還記得那個用來調用文章內容的 the_content() 函數吧,這個函數就提供了一個 the_content 過濾器。
給 the_content 鉤子添加一個函數,這個函數需要接收一個參數,這個參數就是當前的值。
//文章內容全部鏈接新窗口打開 function Bing_autoblank( $content ){//$content 變量就是文章內容,因為其它過濾器也要過濾,所以這個內容可能是經過其它函數過濾的 $content = str_replace( '<a', '<a target="_blank"', $content );//添加 target="_blank" return $content;//必須要把過濾後的內容返回回去,否則值就丟了 } add_filter( 'the_content', 'Bing_autoblank' );
鉤子原理
事實上,在調用 add_action() 和 add_filter() 的時候,只是向 $wp_filter 全局變量添加了一個數組元素,還要說的就是動作和過濾器是公用的一個全局變量,也就是說,過濾器和動作是不能重名的。
當調用 do_action() 的時候,會查找 $wp_filter 全局變量中都有哪些添加到此動作的函數,循環執行即可。
apply_filters() 比 do_action() 多了一個步奏,就是每次調用函數時還要接收這個函數的返回值,最後把經過多次過濾的值返回出去,供使用。
獲取當前鉤子列表
WordPress 的動作和過濾器是插件機制的核心部分,允許你在特定的地方主動添加自己需要執行的動作,一般使用 add_action() 和 add_filter() 函數掛載函數。
這些鉤子被儲存在 $wp_filter 全局變量裡,所以,要獲取鉤子列表,可以直接獲取 $wp_filter 全局變量。
<pre><?php var_dump( $GLOBALS['wp_filter'] ); ?></pre>
上邊的代碼會打印出鉤子列表。