萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

Typecho 插件开发教程(一):Hello World 插件结构与生命周期详解

插件目录结构

usr/plugins/HelloWorld/
├── Plugin.php      # 核心类(必须)
├── Action.php      # 可选:自定义路由/动作
├── Widget.php      # 可选:自定义 Widget
└── README.md       # 说明文档

Plugin.php 核心骨架

<?php
if (!defined('__TYPECHO_ROOT_DIR__')) exit;

/**
 * Hello World 插件
 * @package HelloWorld
 * @author qining
 * @version 1.0.0
 * @link https://typecho.org
 */
class HelloWorld_Plugin implements Typecho_Plugin_Interface {
    // 激活:注册挂载点、创建表、初始化配置
    public static function activate() {
        Typecho_Plugin::factory('Widget_Archive')->footer = array('HelloWorld_Plugin', 'render');
        return _t('插件激活成功');
    }

    // 禁用:清理挂载点、删除表、恢复配置
    public static function deactivate() {
        return _t('插件已禁用');
    }

    // 后台配置面板
    public static function config(Typecho_Widget_Helper_Form $form) {
        $name = new Typecho_Widget_Helper_Form_Element_Text('word', NULL, 'Hello World', _t('显示文字'));
        $form->addInput($name);
    }

    // 个人用户配置(可选)
    public static function personalConfig(Typecho_Widget_Helper_Form $form) {}

    // 实现逻辑:在文章尾部输出配置文字
    public static function render() {
        $options = Typecho_Widget::widget('Widget_Options');
        echo '<div class="hello-world">' . $options->plugin('HelloWorld')->word . '</div>';
    }
}

生命周期钩子

  1. activate():后台点击“启用”触发,返回字符串显示为成功提示,抛异常表示失败。
  2. deactivate():点击“禁用”触发,做清理工作。
  3. config():点击“设置”显示配置面板,使用 Typecho_Widget_Helper_Form 构建表单。
  4. personalConfig():用户个人设置面板(较少用)。
  5. render() / 自定义方法:通过 Typecho_Plugin::factory('Widget_X')->hook = array('Class','method') 挂载到核心流程。

常用挂载点示例


// 文章发布后
Typecho_Plugin::factory('Widget_Contents_Post_Edit')->finishPublish = array('MyPlugin', 'onPublish');

// 评论提交前
Typecho_Plugin::factory('Widget_Feedback')->comment = array('MyPlugin', 'filterComment');

// 模板渲染前
Typecho_Plugin::factory('Widget_Archive')->header = array('MyPlugin', 'injectHeader');
Typecho_Plugin::factory('Widget_Archive')->footer = array('MyPlugin', 'injectFooter');

// 后台菜单
Typecho_Plugin::factory('Widget_Admin_Menu')->navBar = array('MyPlugin', 'addMenu');

调试技巧

  • 开启 config.inc.php 中 define('__TYPECHO_DEBUG__', true);
  • 使用 Typecho_Common::dump($var) 格式化输出变量
  • 错误日志:var/log/error.log
copyright © 萬盛學電腦網 all rights reserved