Typecho插件教程一 —— 基本结构

原文地址：http://www.imhan.com/archives/57/

写了有几个Typecho插件了吧，准确地说，这并不是什么很标准、规范的教程，只是个人在插件开发过程的一些总结。写在这里，只是为了和大家分享、交流一下心得。如果有什么错误的地方，也欢迎大家来指正。（附：Hanny的Typecho插件）

我们先来了解一下Typecho插件的基本结构吧。

首先就是头部的信息注释部份。 最上面的注释是插件的功能描述，将显示在插件列表中。

• @package 后跟的是插件的名称。如本插件名称为HelloWorld。
• @author 后跟的是插件的作者。如本插件的作者为qining
• @link 后跟的是插件作者的主页。在插件列表中，点击作者名字，将跳转到该页面。
• @dependence 后跟的是插件的版本依赖。要注意的是：这个不是Typecho的发行版本，而是构建版本。如：9.9.2-*则表示插件运行在构建版本为9.9.2以后的版本。Typecho的构建版本号可以在后台的最下方方便地看到。
• @version 插件的版本号。将作为插件的版本号显示在插件列表。

接着往下，开始插件的类的定义。 插件的类名和插件的文件名及存放路径有关。 Typecho的插件一般采用两种方式来存放。简单的单文件插件，可以直接以“插件名.php”的形式存放在plugins目录下。此时，类名直接与文件名同名。当然，对于复杂一点的插件，一般建议第二种方法：以“Plugin.php”的文件名，存放在plugins的“插件名”子目录下，此时，类的名字就必须为“路径名_Plugin”了。

定义后类后，接下来就是插件的函数接口了。Typecho的插件主要有四个函数接口： public static function activate() 这个是插件的激活接口，主要填写一些插件的初始化程序。

public static function deactivate() 这个是插件的禁用接口，主要就是插件在禁用时对一些资源的释放。

public static function config(Typecho_Widget_Helper_Form $form) 插件的配置面板，用于制作插件的标准配置菜单。

public static function personalConfig(Typecho_Widget_Helper_Form $form) 插件的个性化配置面板。用法暂时还不明，有待Hanny进一步研究。

先说这么多吧，下一篇，将以HelloWorld为例子，介绍一下一些基本用法。