discuzx插件教程4---页面嵌入模块开发

页面嵌入类型脚本格式

1. <?php
   
2. 
   
3. //全局嵌入点类（必须存在）
   
4. class plugin_identifier {
   
5. 
   
6.         function HookId_1() {
   
7.                 ......
   
8.                 return ...;
   
9.         }
   
10. 
    
11.         function HookId_2() {
    
12.                 ......
    
13.                 return ...;
    
14.         }
    
15. 
    
16.         ......
    
17. 
    
18. }
    
19. 
    
20. //脚本嵌入点类
    
21. class plugin_identifier_CURSCRIPT extends plugin_identifier {
    
22. 
    
23.         function HookId_1() {
    
24.                 ......
    
25.                 return ...;
    
26.         }
    
27. 
    
28.         function HookId_2() {
    
29.                 ......
    
30.                 return ...;
    
31.         }
    
32. 
    
33.         ......
    
34. 
    
35. }
    
36. 
    
37. ?>

复制代码

• plugin_
  

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

• identifier
  

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

• CURSCRIPT
  

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

• HookId
  

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

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

1. $_config['plugindeveloper'] = 2;

复制代码

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

1. return array();

复制代码

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

1. 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 类中的其它函数为了便于阅读建议以“_”开头，如：
<?phpclass plugin_sample {        function _updatecache() {                ......                return ...;        }}class plugin_sample_forum extends plugin_sample {        function viewthread_posttop() {                ......                return ...;        }        ......}?>