Discuz插件页面嵌入类型脚本格式

页面嵌入类型脚本格式

//全局嵌入点类（必须存在）
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。

• HookId

[table]
[tr][td=240]函数名[/td][td=230]调用位置[/td][td=130]声明位置[/td][td]参数含义[/td][/tr]
[tr][td]HookId()[/td][td]所有模块执行前被调用[/td][td]脚本嵌入点类[/td][td][/td][/tr]
[tr][td]HookId_output($value)[/td][td]模块执行完毕，模板输出前被调用[/td][td]脚本嵌入点类[/td][td]$value: array('template' => 当前要输出的模版,'message' => showmessage 的信息内容,'values' => showmessage 的信息变量,[/td][/tr]
[tr][td]global_HookId()[/td][td]模块执行完毕，模板输出前被调用[/td][td]全局嵌入点类[/td][td][/td][/tr]
[tr][td]HookId_message($value)[/td][td]showmessage() 执行时调用[/td][td]脚本嵌入点类[/td][td]$value: array('param' => showmessage() 函数的参数数组,[/td][/tr]
[tr][td]ad_adId($value)[/td][td]相应的广告位中调用[/td][td]全局嵌入点类[/td][td]$value: array('params' => 广告位参数,'content' => 当前广告位原本将要显示的内容,[/td][/tr]
[tr][td]common()[/td][td]所有模块执行前被调用[/td][td]全局嵌入点类[/td][td][/td][/tr]
[tr][td]discuzcode($value)[/td][td]discuzcode() 函数执行时调用[/td][td]全局嵌入点类[/td][td]$value: array('param' => caller 函数的参数数组,'caller' => caller 函数，此嵌入点被哪个函数调用'discuzcode' 被 discuzcode() 调用'messagecutstr' 被 messagecutstr() 调用[/td][/tr]
[tr][td]deletethread($value)[/td][td]deletethread() 函数执行时调用[/td][td]全局嵌入点类[/td][td]$value: array('param' => deletethread() 函数的参数数组,'step' => 删除的步骤'check' 检测步骤'delete' 删除步骤[/td][/tr]
[tr][td]deletepost($value)[/td][td]deletepost() 函数执行时调用[/td][td]全局嵌入点类[/td][td]$value: array('param' => deletepost() 函数的参数数组,'step' => 删除的步骤'check' 检测步骤'delete' 删除步骤[/td][/tr]
[tr][td]avatar($value)[/td][td]avatar() 函数执行时调用[/td][td]全局嵌入点类[/td][td]$value: array('param' => avatar() 函数的参数数组[/td][/tr]
[tr][td]profile_node($post, $start, $end)[/td][td]贴内用户信息标记，返回值为标记显示内容[/td][td]全局嵌入点类[/td][td]$post: 当前帖子信息数组[/td][/tr]
[/table]

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

$_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 类中的其它函数为了便于阅读建议以“_”开头，如：