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

[复制链接]
ARCHY明星会员实名认证 发表于 2012-9-10 13:36:33 [Discuz开发] 显示全部楼层 |阅读模式 上一主题 下一主题
ad广告
ad广告

马上注册,一起探讨正确快速的建站方法

您需要 登录 才可以下载或查看,没有帐号?快速注册

x
discuz 插件页面嵌入类型脚本格式
  1. <?php

  2. //全局嵌入点类(必须存在)
  3. class plugin_identifier {

  4.         function HookId_1() {
  5.                 ......
  6.                 return ...;
  7.         }

  8.         function HookId_2() {
  9.                 ......
  10.                 return ...;
  11.         }

  12.         ......

  13. }

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

  16.         function HookId_1() {
  17.                 ......
  18.                 return ...;
  19.         }

  20.         function HookId_2() {
  21.                 ......
  22.                 return ...;
  23.         }

  24.         ......

  25. }

  26. ?>
复制代码
1、plugin_
普通版脚本中的类名以 plugin_ 开头。手机版脚本中的类名以 mobileplugin_ 开头。

2、identifier
插件的唯一标识符,在插件设置中设置。

3、CURSCRIPT
嵌入点位于的脚本名,如 forum.php 为 forum。

HookId
函数名 调用位置声明位置第一个参数含义
HookId()所有模块执行前被调用脚本嵌入点类
HookId_output()模块执行完毕,模板输出前被调用脚本嵌入点类array(
'template' => 当前要输出的模版,
'message' => showmessage 的信息内容,
'values' => showmessage 的信息变量,
)
global_HookId()模块执行完毕,模板输出前被调用全局嵌入点类
HookId_message()showmessage() 执行时调用脚本嵌入点类array(
'param' => showmessage() 函数的参数数组,
)
ad_adId()相应的广告位中调用
函数名为广告位脚本 ID 如:ad_headerbanner()
全局嵌入点类
脚本嵌入点类
array(
'params' => 广告位参数,
'content' => 当前广告位原本将要显示的内容,
)
common()所有模块执行前被调用全局嵌入点类
discuzcode()discuzcode() 函数执行时调用
用于在帖子内容解析时嵌入自己的功能,函数中 $_G['discuzcodemessage'] 变量为待解析的字串
全局嵌入点类array(
'param' => caller 函数的参数数组,
'caller' => caller 函数,此嵌入点被哪个函数调用
'discuzcode' 被 discuzcode() 调用
'messagecutstr' 被 messagecutstr() 调用
)
deletethread()deletethread() 函数执行时调用
用于在主题删除前后嵌入自己的功能,此函数将在 deletethread() 中被调用 2 次,函数中 $_G['deletethreadtids'] 变量为待处理的 TID 数组
全局嵌入点类array(
'param' => deletethread() 函数的参数数组,
'step' => 删除的步骤
'check' 检测步骤
'delete' 删除步骤
)
deletepost()deletepost() 函数执行时调用
用于在帖子删除前后嵌入自己的功能,此函数将在 deletepost() 中被调用 2 次,函数中 $_G['deletepostids'] 变量为待处理的 ID 数组
全局嵌入点类array(
'param' => deletepost() 函数的参数数组,
'step' => 删除的步骤
'check' 检测步骤
'delete' 删除步骤
)
avatar()
(X2.5 新增)
avatar() 函数执行时调用
用于在头像调用时嵌入自己的功能,函数中 $_G['hookavatar'] 变量为新头像返回值

全局嵌入点类array(
'param' => avatar() 函数的参数数组
)


要查看所有的预定义嵌入点,请打开 config/config_global.php 文件,将文件结尾添加的设计者模式值改成“2”,然后更新缓存即可。在页面源码中查找"<hook>"可搜索到嵌入点。(详细内容可参阅的《插件嵌入点列表》)
  1. $_config['plugindeveloper'] = 2;
复制代码
预定义的嵌入点会在页面预置好的位置输出函数返回的内容。函数返回值类型如果是 array 且是空值的,必须输出一个空数组,如:

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

function CURMODULE_USERDEFINE[_output]()

CURMODULE 指明了此函数在哪个模块执行,可通过常量 CURMODULE 得到当前页面的 CURMODULE 值。 USERDEFINE 可自定义,如果函数名以“_output”结尾则会在模板输出前调用,否则会在模块执行前调用。 如:attachment_test() 函数会在论坛的下载附件的时候执行。 “_output”结尾的函数的第一个参数为数组,含义为 array('template' => 要输出的模板名, 'message' => showmessage 的文字) 如:以下函数将在登录的时候输出调试文字
  1. function logging_test_output($a) {
  2.         print_r($a);
  3.         print_r($_POST);
  4. }
复制代码
plugin_identifier 类中的其它函数为了便于阅读建议以“_”开头,如:
  1. <?php

  2. class plugin_sample {

  3.         function _updatecache() {
  4.                 ......
  5.                 return ...;
  6.         }

  7. }

  8. class plugin_sample_forum extends plugin_sample {

  9.         function viewthread_posttop() {
  10.                 ......
  11.                 return ...;
  12.         }

  13.         ......

  14. }

  15. ?>
复制代码
插件嵌入点列表,详见Discuz模板中插件嵌入点显示位置的注释图




上一篇:Discuz!插件的通过数据库读取和缓存读取获取插件信息和参数
下一篇:Discuz插件接口、插件模块和插件变量配置

大神点评2

 发表于 2012-9-11 22:44:52
转播微博
zoran 发表于 2012-9-24 20:29:28 [Discuz开发] 显示全部楼层
大神。。。。
您需要登录后才可以回帖 登录 | 快速注册

本版积分规则

快速回复 返回顶部 返回列表