Typecho插件教程

由 admin 发布

写了有几个Typecho插件了吧,准确地说,这并不是什么很标准、规范的教程,只是个人在插件开发过程的一些总结。写在这里,只是为了和大家分享、交流一下心得。如果有什么错误的地方,也欢迎大家来指正。(附:Hanny的Typecho插件)http://www.imhan.com/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为例子,介绍一下一些基本用法。

在看这个例子之前,我们还需要稍微了解一下几个小规则。

一个就是Typecho类的命名规规。Typecho类的命名是直接与类的存放位置相挂钩的,存放在var的目录下。比如说,Typecho_Plugin_Interface,就是存放在var/Typecho/Plugin目录下的Interface.php文件。再比如说:Typecho_Widget_Helper_Form_Element_Text 就是存放在var/Typecho/Widget/Helper/Form/Element/Text.php 中。明白了这一点,我们就可以通过参考其它插件,直接找到对应的源文件,来弄清里面的接口。

第二个需要弄明白的就是,明白Typecho哪里可以插,需要怎么插。Typecho的程序中预留了很多可以被插的接口。在Widget中,我们可以看到很多pluginHandle这样的地方;在admin下,我们可以看到Typecho_Plugin::factory这样的地方。这些,都是可以被插的。对这些函数指针重新赋值,则会在对应的位置被调用。

回到我们的HelloWorld插件,

Typecho_Plugin::factory('admin/menu.php')->navBar = array('HelloWorld_Plugin', 'render');

这句话告诉我们,在admin/menu.php目录下,有一个叫navBar的函数指针,将被定位到HelloWord_Plugin类的render函数下。而render函数又做了什么呢?我们接着看:

public static function render()<br />
    {<br />
        echo '<span class="message success">' . Typecho_Widget::widget('Widget_Options')->plugin('HelloWorld')->word . '</span>';<br />
    }

Typecho_Widget::widget('Widget_Options')->plugin('HelloWorld')->word 是配置里填写的字段的内容。
先不理会这个Option的作用,我们可以看到,大概是输出了一段HTML,其实就是输出了在配置里真写的字段的内容。

我们再打开admin/menu.php这个文件

<p class="operate"><?php Typecho_Plugin::factory('admin/menu.php')->navBar(); _e('欢迎'); ?>, <a href="<?php $options->adminUrl('profile.php'); ?>" class="author important"><?php $user->screenName(); ?></a>

其实,就是管理页面右上角内容的输出。

如果这里的navBar被指到了render,也就是说,在输出欢迎之前,通过调用render输出了配置里填写的字段。

讲到这里,差不多也明白这个插件的用途了。

typecho运行html插件,插件接口及功能列表

插件接口及功能列表

默认接口

在Typecho中只要这个类是继承自Typecho_Widget基类,它就默认具备了这个插件接口。接口开发者可以使用这个接口无缝地向当前的Class中注入方法

比如我要给Widget_Archive类增加一个方法获取当前文章的字数(charactersNum),只需要在你的插件activate方法中声明

Typecho_Plugin::factory('Widget_Archive')->___charactersNum = array('MyPlugin', 'charactersNum');

注意,我们在方法名前面加三个下划线表示这是一个内部方法。而实现这个方法也很简单,因为系统会将当前的对象作为参数传递给你

public static function charactersNum($archive)

{undefined

return mb_strlen($archive->text, 'UTF-8');

}

那么这个方法就已经植入到Widget_Archive中去了,你在模版中可以直接调用如下代码输出它

<?php $this->charactersNum(); ?>

至于别的接口自己参照官方表:http://docs.typecho.org/plugins/hooks

官方文档:http://docs.typecho.org/start


您的大名:
万水千山总是情,给个打赏行不行。 打赏

暂无评论

发表评论