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方法

本节完。

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

赞 (0)

相关推荐

  • typecho插件编写教程（二）:写一个新插件

    typecho插件编写教程（二）:写一个新插件

    第一节我们了解了一个插件的基本构成,下面我们需要一个实例练习巩固. 真赶巧,老高最近正在改版百度sitemap提交插件for typecho,下面和老高一起改版吧! 准备 不知道大家用过WP版的百度结构化插件没?老高就是研究了那个插件,观察其API,然后就写出了typecho版的. 为什么要改版呢? 百度站长最近推出新的接口,使用起来更简单,工作量不算大,索性就改改吧! 新版插件需要实现哪些功能? 1.文章实时推送 2.推送历史数据 3.站点地图 接口调用地址(API)在哪儿? 百度站长后台,P

  • typecho插件编写教程（四）：插件挂载

    终于,在能够保存配置信息后,我们可以开始编写插件的挂载功能了. 首先我们需要知道系统为我们在各个关键的环节都预留了插件点给我们,系统运行到插件点时,会检测到是否有插件挂在这个点上,然后执行插件的逻辑! 插件的工作就是找到合适的插件点,挂上去,然后执行自己的逻辑. 插件点,插件钩子,插件接口...在老高这儿是一个概念 官方的插件接口及功能列表 我们的插件需要执行的逻辑在这里,Widget_Contents_Post_Edit类的finishPublish方法 文件路径var/Widget/Cont

  • typecho插件编写教程（五）：核心代码

    之前啰嗦了很多,现在开始写核心代码. 分析一下,发布文章的时候,我们需要的信息就是当前文章的URL,我们需要想办法从$contents. $class中拿到他. 目前我们的插件类代码如下(请注意render被我改成了send) 复制代码 代码如下: class BaiduSubmitTest_Plugin implements Typecho_Plugin_Interface { public static function activate(){         //挂载发布文章和页面的接口

  • typecho插件编写教程（六）：调用接口

    此篇我们开始调用接口,我们在插件类中新定义一个方法,起名为send_post,在方法中我们通过系统配置获取接口调用地址. 百度给的例子中使用了php的CURL,更高级的使用方法可以学习PHP_cURL初始化和执行方法 下面我们结合一下百度站长提供的代码. /** * 发送数据 * @param $url 准备发送的url * @param $options 系统配置 */ public static function send_post($url, $options){ //获取API $api

  • Typecho程序伪静态规则大全(包括Linux/Windows)

    虽然老左博客是用的Wordpress程序,但是我不得不说wp程序即便是一款非常棒的程序之一,但是在资源占用方面的问题还是比较差的.如果你使用过WP程序建立博客应该知道,在网站访问量达到几百的时候一般的主机CPU会超标,甚至会出现被暂停主机使用.因为一般的主机产品CPU限制为5-10%,所以很容易超标.Typecho博客程序是国人开发的,虽然目前不在更新但是功能基本完善,结构看类似WORDPRESS,但是在占用资源上比WP好很多.所以Typecho用户还是非常多的. Typecho程序的伪静态规则

  • 在Nginx服务器上安装配置博客程序Typecho的教程

    在Nginx服务器上安装配置博客程序Typecho的教程

    typecho比wordpress更轻,更专注于写的享受. 现在大多的虚拟机运行环境都是lnmp,安装教程安装typecho可能会遇到404,数据配置错误问题. 把这两天安装typecho的步骤写下来给大家参考. typecho安装方法 1.下载 #网站目录 cd /usr/local/nginx/html/ wget https://github.com/typecho/typecho/releases/download/v0.9-13.12.12-release/0.9.13.12.12.-

  • typecho插件编写教程（三）:保存配置

    typecho插件编写教程（三）:保存配置

    上一节我们制作了一个裸插件,下面我们开始让我们的插件开始工作! I. 完善方法 两个方法 我们实现activate和deactivate方法 复制代码 代码如下: public static function activate(){         return 'activate';     } public static function deactivate(){         return 'deactivated';     } 如上代码所示,我们在激活和卸载插件方法中有返回值,所以

  • typecho插件编写教程（一）:Hello World

    typecho插件编写教程（一）:Hello World

    最近老高正在编写一个关于typecho的插件,由于typecho不像wordpress,有那么多的文档参考,写一个插件还是遇到了很多的坑,不过随着研究的不断深入,老高也慢慢上手了,于是总结出此篇编写教程分享给大家! I. 从HelloWorld说起 基本信息 想必想要开发typecho的你一定阅读过官方示例插件HelloWorld的源码吧? 我们先看看usr/plugins/HelloWorld/Plugin.php文件前几行 复制代码 代码如下: if (!defined('__TYPECHO

  • 详解PyCharm安装MicroPython插件的教程

    前言 PyCharm可以说是当今最流行的一款Python IDE了,大部分购买TPYBoard的小伙伴都会使用PyCharm编写MicroPython的程序.遗憾的是,只是把PyCharm当做了一种代码编辑器,调试依然还的需要其他辅助软件,比如PuTTY.其实最近也有不少小伙伴询问PyCharm中怎么安装MicroPython插件的问题,想着正好网站也缺少这部分的教程,不如实践一下总结下经验共享给大家,也好给爱好MicroPython的小伙伴提供便利. 准备工作 硬件要求 - TPYBoard

  • 油猴脚本编写教程详解

    油猴脚本(Tampermonkey)是一个非常流行的浏览器扩展,它可以运行由广大社区编写的扩展脚本,来实现各式各样的功能,常见的去广告.修改样式文件.甚至是下载视频.今天我们就来看看如何编写自己的油猴脚本.当然为了运行油猴脚本,你应该在浏览器中安装油猴插件. 安装油猴插件 安装油猴插件非常简单,直接在浏览器的扩展商店中安装即可.国产浏览器的话一般可以通过下载扩展文件手动拖动的方式来安装.下图是微软新版Edge浏览器的扩展商店,直接搜索Tampermonkey即可. 新建脚本 首先在浏览器右上角找

  • Typecho插件实现添加文章目录的方法详解

    目录 添加文章标题锚点 显示文章目录 添加文章目录样式 定位到文章 定位到目录 我的长博文不少,比较影响阅读体验,有必要添加一个文章目录功能.相比 Wordpress, Typecho 的插件就比较少了.我想找一个像掘金那样为文章添加目录的插件,没一个合适的.此类教程也不是很多,而且差不多都是前台 JavaScript 来实现的,感觉这样不如后台实现来的好. 注意:我使用的是Joe主题7.3,其他主题文件路径可能不一样. 添加文章标题锚点 1.声明 createAnchor 函数 在 core/

  • eclipse中maven插件安装教程

    eclipse中maven插件安装教程

    本文实例为大家分享了maven插件安装教程,供大家参考,具体内容如下 如果能打印如上信息,说明到此 Maven已经在你的电脑上安装完成. mvn 是 mavn 的一个指令,mvn -version 是查看版本信息,我的操作系统是 64位的 WIN7,安装的 maven 是 3.3.9 如果能打印如上信息,说明到此 Maven已经在你的电脑上安装完成. 修改maven的仓库的存放的位置: 找到 maven 下的 conf 下的 settings.xml 配置文件,我的是在 D:\Server\ma

随机推荐