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

   这篇文章主要介绍了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方法

  本节完。

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

时间: 2024-08-02 00:49:26

typecho插件编写教程(一):Hello World的相关文章

typecho插件编写教程(二):写一个新插件

  这篇文章主要介绍了typecho插件编写教程(二):写一个新插件,本文是系列文章的第二篇,需要的朋友可以参考下 第一节我们了解了一个插件的基本构成,下面我们需要一个实例练习巩固. 真赶巧,老高最近正在改版百度sitemap提交插件for typecho,下面和老高一起改版吧! 准备 不知道大家用过WP版的百度结构化插件没?老高就是研究了那个插件,观察其API,然后就写出了typecho版的. 为什么要改版呢? 百度站长最近推出新的接口,使用起来更简单,工作量不算大,索性就改改吧! 新版插件需

typecho插件编写教程(三):保存配置

  这篇文章主要介绍了typecho插件编写教程(三):保存配置,本文讲解了完善方法.如何保存配置.使用需要注意的问题等内容,需要的朋友可以参考下 上一节我们制作了一个裸插件,下面我们开始让我们的插件开始工作! I. 完善方法 两个方法 我们实现activate和deactivate方法 代码如下: public static function activate(){ return 'activate'; } public static function deactivate(){ return

typecho插件编写教程(四):插件挂载

  这篇文章主要介绍了typecho插件编写教程(四):插件挂载,本文讲解了如何找到插件点并挂载插件的方法,需要的朋友可以参考下 终于,在能够保存配置信息后,我们可以开始编写插件的挂载功能了. 首先我们需要知道系统为我们在各个关键的环节都预留了插件点给我们,系统运行到插件点时,会检测到是否有插件挂在这个点上,然后执行插件的逻辑! 插件的工作就是找到合适的插件点,挂上去,然后执行自己的逻辑. 插件点,插件钩子,插件接口...在老高这儿是一个概念 官方的插件接口及功能列表 我们的插件需要执行的逻辑在

typecho插件编写教程(五):核心代码

  这篇文章主要介绍了typecho插件编写教程(五):核心代码,本文讲解了完整的插件核心代码的示例,需要的朋友可以参考下 之前啰嗦了很多,现在开始写核心代码. 分析一下,发布文章的时候,我们需要的信息就是当前文章的URL,我们需要想办法从$contents. $class中拿到他. 目前我们的插件类代码如下(请注意render被我改成了send) 代码如下: class BaiduSubmitTest_Plugin implements Typecho_Plugin_Interface { p

typecho插件编写教程(六):调用接口

  这篇文章主要介绍了typecho插件编写教程(六):调用接口,这是系列文章的最后一篇,需要的朋友可以参考下 此篇我们开始调用接口,我们在插件类中新定义一个方法,起名为send_post,在方法中我们通过系统配置获取接口调用地址. 百度给的例子中使用了php的CURL,更高级的使用方法可以学习PHP_cURL初始化和执行方法 下面我们结合一下百度站长提供的代码. ? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 2

typecho插件编写教程(一):Hello World_php实例

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

typecho插件编写教程(二):写一个新插件_php实例

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

typecho插件编写教程(六):调用接口_php实例

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

typecho插件编写教程(四):插件挂载_php实例

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