2.3 插件钩子（Hook）

页面嵌入类型脚本格式

<?php

//全局嵌入点类（必须存在）
class plugin_identifier {

    function HookId_1() {
        ......
        return ...;
    }

    function HookId_2() {
        ......
        return ...;
    }

    ......

}

//脚本嵌入点类
class plugin_identifier_CURSCRIPT extends plugin_identifier {

    function HookId_1() {
        ......
        return ...;
    }

    function HookId_2() {
        ......
        return ...;
    }

    ......

}

?>

plugin_

普通版脚本中的类名以 plugin_ 开头。手机版脚本中的类名以 mobileplugin_ 开头。

identifier

插件的唯一标识符，在插件设置中设置。

CURSCRIPT

嵌入点位于的脚本名，如 forum.php 为 forum。

X3.4 最新版本开始支持plugin.php为CURSCRIPT的插件之间的hook调用，CURSCRIPT值为plugin。<span class="xi1">New!</span>

HookId

要查看所有的预定义嵌入点，请打开 config/config_global.php 文件，将文件结尾添加的设计者模式值改成“2”，然后更新缓存即可。在页面源码中查找<hook>可搜索到嵌入点。（详细内容可参阅的《插件嵌入点列表》）

$_config['plugindeveloper'] = 2;

预定义的嵌入点会在页面预置好的位置输出函数返回的内容。函数返回值类型如果是 array 且是空值的，必须输出一个空数组，如：

return array();

函数名并不限于以上列表，您可以自定义，只要符合以下规则，函数就会在适当的地方被调用。

function CURMODULE_USERDEFINE[_output]()

CURMODULE 指明了此函数在哪个模块执行，可通过常量 CURMODULE 得到当前页面的 CURMODULE 值。 USERDEFINE 可自定义，如果函数名以“_output”结尾则会在模板输出前调用，否则会在模块执行前调用。

如：attachment_test() 函数会在论坛的下载附件的时候执行。

“_output”结尾的函数的第一个参数为数组，含义为 array('template' => 要输出的模板名, 'message' => showmessage 的文字)

如：以下函数将在登录的时候输出调试文字

function logging_test_output($a) {
    print_r($a);
    print_r($_POST);
}

plugin_identifier 类中的其它函数为了便于阅读建议以“_”开头，如：

<?php

class plugin_sample {

    function _updatecache() {
        ......
        return ...;
    }

}

class plugin_sample_forum extends plugin_sample {

    function viewthread_posttop() {
        ......
        return ...;
    }

    ......

}

?>

插件嵌入点列表

附: 插件嵌入点列表

<p class="xg1" align="right">更新时间：2013-1-28</p>

整理自 Discuz! 官方开放平台技术文档（open.dismall.com），由 WorkBuddy 整理发布。