typecho插件编写教程(一):Hello World

 更新时间:2015年05月28日 11:49:23   投稿:junjie  
这篇文章主要介绍了typecho插件编写教程(一):Hello World,本文讲解了插件的文件结构、插件信息、插件结构、插件流程等内容,需要的朋友可以参考下

最近老高正在编写一个关于typecho的插件,由于typecho不像wordpress,有那么多的文档参考,写一个插件还是遇到了很多的坑,不过随着研究的不断深入,老高也慢慢上手了,于是总结出此篇编写教程分享给大家!

I. 从HelloWorld说起

基本信息

想必想要开发typecho的你一定阅读过官方示例插件HelloWorld的源码吧?

我们先看看usr/plugins/HelloWorld/Plugin.php文件前几行

复制代码 代码如下:

if (!defined('__TYPECHO_ROOT_DIR__')) exit;
/**
 * Hello World
 *
 * @package HelloWorld
 * @author qining
 * @version 1.0.0
 * @link http://typecho.org
 */
 ...
 ...

这几行代码是一个插件的基本信息,我们由代码可以得出以下与插件相关的基本信息

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

同时这些信息都会显示在插件页中,如下图

插件结构

我们继续向后面的代码看,一个最简单的插件结构如下(为了缩短篇幅,老高移除了具体方法的实现)

每个方法基本都有注释,老高不再赘述。

看起来很简单吧?其实里面还是有不少坑的。

复制代码 代码如下:

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){}

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

    /**
     * 插件实现方法
     *
     * @access public
     * @return void
     */
    public static function render(){}
}

插件流程

插件的基本流程是这样的。

1.当我们的插件写好后会出现在后台
2.点击启用按钮后,会执行对应插件类的activate方法
3.插件与目标插件点关联,等待触发
4.当点击停用的时候调用deactivate方法

本节完。

下一节老高会更详细的说明插件类的方法。

相关文章

  • Thinkphp5框架异常处理操作实例分析

    Thinkphp5框架异常处理操作实例分析

    这篇文章主要介绍了Thinkphp5框架异常处理操作,结合实例形式分析了Thinkphp5框架异常处理操作原理、操作方法与相关使用技巧,需要的朋友可以参考下
    2020-06-06
  • curl不使用文件存取cookie php使用curl获取cookie示例

    curl不使用文件存取cookie php使用curl获取cookie示例

    这篇文章主要介绍了curl不使用文件存取cookie的示例,不使用COOKIEJAR和COOKIEFILE存取COOKIE,大家参考使用吧
    2014-01-01
  • docker-compose部署php项目实例详解

    docker-compose部署php项目实例详解

    在本篇文章里小编给大家整理了关于docker-compose部署php项目的相关实例以及代码内容,有需要的朋友们可以学习参考下。
    2019-07-07
  • thinkphp的c方法使用示例

    thinkphp的c方法使用示例

    用过thinkphp的朋友都知道,C()方法在整个框架中用的非常普遍,C方法的实现非常简单,但是功能非常强大,下面是C()方法的详解和使用示例
    2014-02-02
  • 微信自定义菜单的处理开发示例

    微信自定义菜单的处理开发示例

    在微信5.0以前,自定义菜单是作为一种内测资格使用的,只有少数公众帐号拥有菜单,因此出现很多企业为了弄到菜单不惜重金求购。现如今,一大批帐号从订阅号转为服务号,很多都是奔着自定义菜单去的。今天我们就来简单研究下微信自定义菜单的处理。
    2015-04-04
  • PHP代码实现表单数据验证类

    PHP代码实现表单数据验证类

    这篇文章主要介绍了PHP代码实现表单数据验证类,需要的朋友可以参考下
    2015-07-07
  • php桌面中心(三) 修改数据库

    php桌面中心(三) 修改数据库

    php桌面中心(三) 修改数据库...
    2007-03-03
  • php发送短信验证码完成注册功能

    php发送短信验证码完成注册功能

    这篇文章主要介绍了php发送短信验证码完成注册功能的详细步骤,感兴趣的小伙伴们可以参考一下
    2015-11-11
  • PHP parser重写PHP类使用示例详解

    PHP parser重写PHP类使用示例详解

    这篇文章主要为大家介绍了PHP parser重写PHP类使用示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-09-09
  • laravel 5.4中实现无限级分类的方法示例

    laravel 5.4中实现无限级分类的方法示例

    最近在工作中遇到一个需求,是要在laravel 5.4中实现无限级分类,但发现网上这个的资料较少,所以只能自己来实现了,下面这篇文章主要给大家介绍了关于在laravel 5.4中实现无限级分类的方法示例,需要的朋友可以参考借鉴,下面来一起看看吧。
    2017-07-07

最新评论