快捷導(dǎo)航

typecho插件編寫教程（一）:Hello World

更新時(shí)間：2015年05月28日 11:49:23 投稿：junjie

這篇文章主要介紹了typecho插件編寫教程（一）:Hello World,本文講解了插件的文件結(jié)構(gòu)、插件信息、插件結(jié)構(gòu)、插件流程等內(nèi)容,需要的朋友可以參考下

最近老高正在編寫一個(gè)關(guān)于typecho的插件，由于typecho不像wordpress，有那么多的文檔參考，寫一個(gè)插件還是遇到了很多的坑，不過隨著研究的不斷深入，老高也慢慢上手了，于是總結(jié)出此篇編寫教程分享給大家！

I. 從HelloWorld說起

基本信息

想必想要開發(fā)typecho的你一定閱讀過官方示例插件HelloWorld的源碼吧？

我們先看看usr/plugins/HelloWorld/Plugin.php文件前幾行

復(fù)制代碼代碼如下:

if (!defined('__TYPECHO_ROOT_DIR__')) exit;

/**

 * Hello World

 * 

 * @package HelloWorld 

 * @author qining

 * @version 1.0.0

 * @link http://typecho.org

 */

 ...

 ...

這幾行代碼是一個(gè)插件的基本信息，我們由代碼可以得出以下與插件相關(guān)的基本信息

插件說明 ---> Hello World
插件包名 ---> HelloWorld
插件作者 ---> qining
插件版本 ---> 1.0.0
插件鏈接 ---> http://typecho.org

同時(shí)這些信息都會(huì)顯示在插件頁中，如下圖

插件結(jié)構(gòu)

我們繼續(xù)向后面的代碼看，一個(gè)最簡(jiǎn)單的插件結(jié)構(gòu)如下（為了縮短篇幅，老高移除了具體方法的實(shí)現(xiàn)）

每個(gè)方法基本都有注釋，老高不再贅述。

看起來很簡(jiǎn)單吧？其實(shí)里面還是有不少坑的。

復(fù)制代碼代碼如下:

class HelloWorld_Plugin implements Typecho_Plugin_Interface
{
    /**
     * 激活插件方法,如果激活失敗,直接拋出異常
     *
     * @access public
     * @return void
     * @throws Typecho_Plugin_Exception
     */
    public static function activate(){}

    /**
     * 禁用插件方法,如果禁用失敗,直接拋出異常
     *
     * @static
     * @access public
     * @return void
     * @throws Typecho_Plugin_Exception
     */
    public static function deactivate(){}

    /**
     * 獲取插件配置面板
     *
     * @access public
     * @param Typecho_Widget_Helper_Form $form 配置面板
     * @return void
     */
    public static function config(Typecho_Widget_Helper_Form $form){}

    /**
     * 個(gè)人用戶的配置面板
     *
     * @access public
     * @param Typecho_Widget_Helper_Form $form
     * @return void
     */
    public static function personalConfig(Typecho_Widget_Helper_Form $form){}

    /**
     * 插件實(shí)現(xiàn)方法
     *
     * @access public
     * @return void
     */
    public static function render(){}
}

插件流程

插件的基本流程是這樣的。

1.當(dāng)我們的插件寫好后會(huì)出現(xiàn)在后臺(tái)
2.點(diǎn)擊啟用按鈕后，會(huì)執(zhí)行對(duì)應(yīng)插件類的activate方法
3.插件與目標(biāo)插件點(diǎn)關(guān)聯(lián)，等待觸發(fā)
4.當(dāng)點(diǎn)擊停用的時(shí)候調(diào)用deactivate方法

本節(jié)完。

下一節(jié)老高會(huì)更詳細(xì)的說明插件類的方法。

您可能感興趣的文章: