Z-Blog Wiki Z-Blog Wiki

Z-Blog官方文库

用户工具

站点工具


zblogphp:development:plugin:interfaces

这是本文档旧的修订版!


目录

Z-BlogPHP 系统接口列表

为了应对各种各样的扩展需求,Z-BlogPHP提供了几类插件接口供开发者使用,要说明如下

  • 管理页面输出类:这一类接口一般用于在后台现有管理页面中添加按钮或者扩展选项内容
  • 接管系统方法类:系统方法接管的位置一般有两种:
    1. Core:在数据提交前介入,可用于过滤提交的数据内容
    2. Succeed:在数据提交成功后介入,可用于数据提交后的事件处理,如更新自定义模块数据等
  • 魔术方法类:用于扩展系统类中的可用方法
  • 前台页面输出类:如首页的起始、结尾,列表、文章、搜索页面等等起始位置,添加脚本等

c_system_dubug,c_system_common里的接口


Filter_Plugin_Debug_Handler

调用方法 定义Debug_Shutdown_Handler,Debug_Exception_Handler,Debug_Error_Handler函数的接口

调用参数 $type 类型(Shutdown|Exception|Error) $error 错误数据(对象或数组)

Filter_Plugin_Debug_Display

调用方法 定义ZBlogException的Display函数的接口

调用参数

Filter_Plugin_Autoload

调用方法 监控autoload魔术方法

调用参数 $classname

Filter_Plugin_Logs

调用方法 监控记录函数

调用参数 $s,$iserror

DbSql类里的接口


Filter_Plugin_DbSql_Filter

调用方法 DbSql类的SQL过滤和统计方法接口

调用参数 $method, $args

ZBP类里的接口


Filter_Plugin_Zbp_Call

调用方法 Zbp类的魔术方法接口

调用参数 $method, $args

Filter_Plugin_Zbp_Get

调用方法 Zbp类的魔术方法接口

调用参数 $name

Filter_Plugin_Zbp_Set

调用方法 Zbp类的魔术方法接口

调用参数 $name,$value

Filter_Plugin_Zbp_CheckRights

调用方法 Zbp类的检查权限接口(检查当前用户)

调用参数 $action

Filter_Plugin_Zbp_ShowError

调用方法 Zbp类的显示错误接口

调用参数 $idortext

Filter_Plugin_Zbp_ShowValidCode

调用方法 Zbp类的显示验证码接口,具有唯一性;

调用参数 $id

Filter_Plugin_Zbp_CheckValidCode

调用方法 Zbp类的比对验证码接口,具有唯一性;

调用参数 $vaidcode,$id

Filter_Plugin_Zbp_BuildTemplate

调用方法 Zbp类的重新编译模板接口

调用参数 $template

Filter_Plugin_Zbp_MakeTemplatetags

调用方法 Zbp类的生成模板标签接口

调用参数 $template

Filter_Plugin_Zbp_BuildModule

调用方法 Zbp类的生成模块内容的接口

调用参数

Filter_Plugin_Zbp_Load

调用方法 Zbp类的加载接口

调用参数

Filter_Plugin_Zbp_Load_Pre

调用方法 Zbp类的加载(预处理)接口

调用参数

Filter_Plugin_Zbp_LoadManage

调用方法 Zbp类的后台管理初始加载接口

调用参数

Filter_Plugin_Zbp_Terminate

调用方法 Zbp类的终结接口

调用参数

前台view,index


Filter_Plugin_Index_Begin

调用方法 定义index.php接口 起动

调用参数

Filter_Plugin_Index_End

调用方法 定义index.php接口 结束

调用参数

Filter_Plugin_Html_Js_Add

调用方法 c_html_js_add.php脚本接口,允许插件在c_html_js_add.php内输出内容

调用参数

Filter_Plugin_Html_Js_ZbpConfig

调用方法 c_html_js_add.php脚本接口,允许插件设置zbpConfig

调用参数

Filter_Plugin_Search_Begin

调用方法 搜索页接口,可以接管搜索页。

调用参数

Filter_Plugin_Search_End

调用方法 搜索接口 结束

调用参数

Filter_Plugin_Feed_Begin

调用方法 Feed页接口,可以接管Feed页。

调用参数

Filter_Plugin_Feed_End

调用方法 Feed页接口 结束

调用参数

cmd.php里的接口


Filter_Plugin_Cmd_Begin

调用方法 cmd.php的启动接口,可以在这里拦截各种action

调用参数

Filter_Plugin_Cmd_End

调用方法 cmd.php的结束接口,可以在这里拦截各种action之后的

调用参数

Filter_Plugin_Cmd_Ajax

调用方法 cmd.php的Ajax命令专用接口,插件需要自行判断权限

调用参数

Filter_Plugin_Misc_Begin

调用方法 c_system_misc.php的启动接口,可以在这里拦截各种type

调用参数 $type 类型

后台管理里的接口


Filter_Plugin_Login_Header

调用方法 定义Login.php首页header接口

调用参数

Filter_Plugin_Other_Header

调用方法 定义其它页的header接口

调用参数

Filter_Plugin_Admin_Begin

调用方法 后台管理页的启动接口,可以拦截后台管理请求实现自己的管理

调用参数

Filter_Plugin_Admin_Other_Action

调用方法 后台管理页的拦截后台管理请求实现自己的Action

调用参数

Filter_Plugin_Admin_End

调用方法 后台管理页的终结接口

调用参数

Filter_Plugin_Admin_Header

调用方法 定义后台首页header接口

调用参数

调用方法 定义后台首页footer接口

调用参数

Filter_Plugin_Admin_LeftMenu

调用方法 定义后台左侧栏接口

调用参数 &$leftmenus

Filter_Plugin_Admin_TopMenu

调用方法 定义后台顶部导航栏接口

调用参数 &$topmenus

Filter_Plugin_Admin_SiteInfo_SubMenu

调用方法 后台首页SubMenu

调用参数

Filter_Plugin_Admin_ArticleMng_SubMenu

调用方法 文章管理SubMenu

调用参数

Filter_Plugin_Admin_PageMng_SubMenu

调用方法 页面管理

调用参数

Filter_Plugin_Admin_CategoryMng_SubMenu

调用方法 分类管理

调用参数

Filter_Plugin_Admin_CommentMng_SubMenu

调用方法 评论管理

调用参数

Filter_Plugin_Admin_MemberMng_SubMenu

调用方法 用户管理

调用参数

Filter_Plugin_Admin_UploadMng_SubMenu

调用方法

调用参数

Filter_Plugin_Admin_TagMng_SubMenu

调用方法 标签管理

调用参数

Filter_Plugin_Admin_PluginMng_SubMenu

调用方法 插件管理

调用参数

Filter_Plugin_Admin_ThemeMng_SubMenu

调用方法 主题管理

调用参数

Filter_Plugin_Admin_ModuleMng_SubMenu

调用方法 模块管理

调用参数

Filter_Plugin_Admin_SettingMng_SubMenu

调用方法 设置管理

调用参数

Filter_Plugin_Edit_SubMenu

调用方法 编辑页菜单(1.5.1加入)

调用参数

Filter_Plugin_Tag_Edit_SubMenu

调用方法 标签编辑页菜单(1.5.1加入)

调用参数

Filter_Plugin_Module_Edit_SubMenu

调用方法 模块编辑页菜单(1.5.1加入)

调用参数

Filter_Plugin_Member_Edit_SubMenu

调用方法 用户编辑页菜单(1.5.1加入)

调用参数

Filter_Plugin_Category_Edit_SubMenu

调用方法 分类编辑页菜单(1.5.1加入)

调用参数

Filter_Plugin_Admin_ArticleMng_Table

调用方法 文章管理页表处理(1.5.1加入)

调用参数 &$article,&$tabletds,&$tableths

Filter_Plugin_Admin_PageMng_Table

调用方法 页面管理页表处理(1.5.1加入)

调用参数 &$article,&$tabletds,&$tableths

Filter_Plugin_Admin_CategoryMng_Table

调用方法 分类管理页表处理(1.5.1加入)

调用参数 &$category,&$tabletds,&$tableths

Filter_Plugin_Admin_CommentMng_Table

调用方法 评论管理页表处理(1.5.1加入)

调用参数 &$cmt,&$tabletds,&$tableths,$article

Filter_Plugin_Admin_MemberMng_Table

调用方法 会员管理页表处理(1.5.1加入)

调用参数 &$member,&$tabletds,&$tableths

Filter_Plugin_Admin_UploadMng_Table

调用方法 附件管理页表处理(1.5.1加入)

调用参数 &$upload,&$tabletds,&$tableths

Filter_Plugin_Admin_TagMng_Table

调用方法 Tag管理页表处理(1.5.1加入)

调用参数 &$tag,&$tabletds,&$tableths

Filter_Plugin_Edit_Begin

调用方法 文章页面编辑页开始接口

调用参数

Filter_Plugin_Edit_End

调用方法 文章页面编辑页结束接口

调用参数

Filter_Plugin_Edit_Response

调用方法 文章页面编辑1号输出接口

调用参数

Filter_Plugin_Edit_Response2

调用方法 文章页面编辑2号输出接口

调用参数

Filter_Plugin_Edit_Response4

调用方法 文章页面编辑4号输出接口

调用参数

Filter_Plugin_Edit_Response5

调用方法 文章页面编辑5号输出接口

调用参数

Filter_Plugin_Edit_Response3

调用方法 文章页面编辑3号输出接口

调用参数

Filter_Plugin_Category_Edit_Response

调用方法 分类编辑页输出接口

调用参数

Filter_Plugin_Tag_Edit_Response

调用方法 标签编辑页输出接口

调用参数

Filter_Plugin_Member_Edit_Response

调用方法 会员编辑页输出接口

调用参数

Filter_Plugin_Module_Edit_Response

调用方法 模块编辑页输出接口

调用参数

Filter_Plugin_Admin_Js_Add

调用方法 c_admin_js_add.php脚本页的接口

调用参数

Filter_Plugin_OutputOptionItemsOfMemberLevel

调用方法 定义OutputOptionItemsOfMemberLevel函数里的接口

调用参数 $default,$tz

Filter_Plugin_OutputOptionItemsOfMember_Begin

调用方法 定义Filter_Plugin_OutputOptionItemsOfMember函数里的接口

调用参数 $default,$tz

Filter_Plugin_OutputOptionItemsOfCategories

调用方法 定义OutputOptionItemsOfCategories函数里的接口

调用参数 $default,$tz

Filter_Plugin_OutputOptionItemsOfPostStatus

调用方法 定义OutputOptionItemsOfPostStatus函数里的接口

调用参数 $default,$tz

Filter_Plugin_OutputOptionItemsOfIsTop

调用方法 定义OutputOptionItemsOfIsTop函数里的接口

调用参数 $default,$tz

Filter_Plugin_OutputOptionItemsOfMember

调用方法 定义OutputOptionItemsOfMember函数里的接口

调用参数 $default,$tz

Filter_Plugin_OutputOptionItemsOfTemplate

调用方法 定义OutputOptionItemsOfTemplate函数里的接口

调用参数 $default,$tz

Filter_Plugin_OutputOptionItemsOfCommon

调用方法 定义OutputOptionItemsOfCommon函数里的接口,因为是通用型的,所以有$name

调用参数 $default,$array,$name

c_system_event.php里的接口


Filter_Plugin_VerifyLogin_Succeed

调用方法 VerifyLogin成功的接口

调用参数

Filter_Plugin_Logout_Succeed

调用方法 Logout成功的接口

调用参数

Filter_Plugin_GetPost_Result

调用方法 定义GetPost输出结果接口

调用参数 &$post

Filter_Plugin_GetList_Result

调用方法 定义GetList输出结果接口

调用参数 &$list

Filter_Plugin_ViewIndex_Begin

调用方法 定义ViewIndex输出接口Begin

调用参数

Filter_Plugin_ViewFeed_Begin

调用方法 定义ViewFeed输出接口Begin

调用参数

Filter_Plugin_ViewSearch_Begin

调用方法 定义ViewSearch输出接口Begin

调用参数

Filter_Plugin_ViewAuto_Begin

调用方法 定义ViewAuto输出接口Begin

调用参数 &$url

Filter_Plugin_ViewAuto_End

调用方法 定义ViewAuto输出接口End

调用参数 &$url

Filter_Plugin_ViewList_Begin

调用方法 定义列表输出接口

调用参数 &$page,&$cate,&$auth,&$date,&$tags

Filter_Plugin_ViewList_Core

调用方法 定义列表核心接口

调用参数 &$type,&$page,&$category,&$author,&$datetime,&$tag,&$w,&$pagebar

Filter_Plugin_ViewSearch_Core

调用方法 定义搜索核心接口

调用参数 $q, $page, $w, $pagebar

Filter_Plugin_ViewList_Core

调用方法 定义Feed核心接口

调用参数 $w

Filter_Plugin_ViewFeed_End

调用方法 定义Feed核心接口

调用参数 $rss2

Filter_Plugin_ViewPost_Begin

调用方法 定义POST显示输出begin接口

调用参数 &$id,&$alias

Filter_Plugin_ViewPost_Core

调用方法 定义POST显示核心接口

调用参数 &$select,&$w,&$order,&$limit,&$option

Filter_Plugin_ViewList_Template

调用方法

调用参数 &$template

Filter_Plugin_ViewPost_Template

调用方法

调用参数 &$template

Filter_Plugin_ViewSearch_Template

调用方法

调用参数 &$template

Filter_Plugin_ViewComments_Template

调用方法

调用参数 &$template

Filter_Plugin_ViewComment_Template

调用方法

调用参数 &$template

Filter_Plugin_PostModule_Core

调用方法 模块编辑的核心接口

调用参数 &$mod

Filter_Plugin_PostMember_Core

调用方法 会员编辑的核心接口

调用参数 &$mem

Filter_Plugin_PostTag_Core

调用方法 标签编辑的核心接口

调用参数 &$tag

Filter_Plugin_PostCategory_Core

调用方法 分类编辑的核心接口

调用参数 &$cate

Filter_Plugin_PostComment_Core

调用方法 评论发表的核心接口

调用参数 &$cmt

Filter_Plugin_CheckComment_Core

调用方法 评论审核的核心接口

调用参数 &$cmt

Filter_Plugin_PostArticle_Core

调用方法 文章编辑的核心接口

调用参数 &$article

Filter_Plugin_PostPage_Core

调用方法 页面编辑的核心接口

调用参数 &$article

Filter_Plugin_PostMember_Succeed

调用方法 会员编辑成功的接口

调用参数 &$mem

Filter_Plugin_PostTag_Succeed

调用方法 标签编辑成功的接口

调用参数 &$tag

Filter_Plugin_PostCategory_Succeed

调用方法 分类编辑成功的接口

调用参数 &$cate

Filter_Plugin_PostComment_Succeed

调用方法 评论发表成功的接口

调用参数 &$cmt

Filter_Plugin_CheckComment_Succeed

调用方法 评论审核成功的接口

调用参数 &$cmt

Filter_Plugin_PostPage_Succeed

调用方法 页面编辑成功的接口

调用参数 &$article

Filter_Plugin_PostArticle_Succeed

调用方法 文章编辑成功的接口

调用参数 &$article

Filter_Plugin_PostModule_Succeed

调用方法 模块编辑成功的接口

调用参数 &$mod

Filter_Plugin_DelMember_Succeed

调用方法 会员删除成功的接口

调用参数 &$mem

Filter_Plugin_DelTag_Succeed

调用方法 标签删除成功的接口

调用参数 &$tag

Filter_Plugin_DelCategory_Succeed

调用方法 分类删除成功的接口

调用参数 &$cate

Filter_Plugin_DelComment_Succeed

调用方法 评论删除成功的接口

调用参数 &$cmt

Filter_Plugin_DelPage_Succeed

调用方法 页面删除成功的接口

调用参数 &$article

Filter_Plugin_DelArticle_Succeed

调用方法 文章删除成功的接口

调用参数 &$article

Filter_Plugin_DelModule_Succeed

调用方法 模块删除成功的接口

调用参数 &$mod

Filter_Plugin_EnablePlugin

调用方法 EnablePlugin(1.6.0加入)

调用参数 &name

Filter_Plugin_DisablePlugin

调用方法 DisablePlugin(1.6.0加入)

调用参数 &name

Filter_Plugin_BatchPost

调用方法 BatchPost(1.6.1加入)

调用参数 &type

lib类里的接口


Filter_Plugin_Post_Url

调用方法 干预Post类Url方法的接口

调用参数 &$this

Filter_Plugin_Post_Get

调用方法 干预Post类Get方法的接口

调用参数 &$this, $method

Filter_Plugin_Post_Set

调用方法 干预Post类Set方法的接口

调用参数 &$this, $method, $arg

Filter_Plugin_Category_Url

调用方法 干预Category类Url方法的接口

调用参数 &$this

Filter_Plugin_Category_Get

调用方法 干预Category类Get方法的接口

调用参数 &$this, $method

Filter_Plugin_Category_Set

调用方法 干预Category类Set方法的接口

调用参数 &$this, $method, $arg

Filter_Plugin_Tag_Url

调用方法 干预Tag类Url方法的接口

调用参数 &$this

Filter_Plugin_Category_Get

调用方法 干预Tag类Get方法的接口

调用参数 &$this, $method

Filter_Plugin_Tag_Set

调用方法 干预Tag类Set方法的接口

调用参数 &$this, $method, $arg

Filter_Plugin_Member_Url

调用方法 干预Member类Url方法的接口

调用参数 &$this

Filter_Plugin_Member_Get

调用方法 干预Member类Get方法的接口

调用参数 &$this, $method

Filter_Plugin_Member_Set

调用方法 干预Member类Set方法的接口

调用参数 &$this, $method, $arg

Filter_Plugin_Post_CommentPostUrl

调用方法 Post类的CommentPostUrl接口

调用参数 $post

Filter_Plugin_Post_Prev

调用方法 Post类的Prev接口

调用参数 $post

Filter_Plugin_Post_Next

调用方法 Post类的Next接口

调用参数 $post

Filter_Plugin_Post_RelatedList

调用方法 Post类的RelatedList 接口

调用参数 $post

Filter_Plugin_Post_Call

调用方法 Post类的魔术方法接口

调用参数 &$post,$method,$args

Filter_Plugin_Comment_Call

调用方法 Comment类的魔术方法接口

调用参数 &$comment,$method,$args

Filter_Plugin_Comment_Get

调用方法 干预Comment类Get方法的接口

调用参数 &$this, $method

Filter_Plugin_Comment_Set

调用方法 干预Comment类Set方法的接口

调用参数 &$this, $method, $arg

Filter_Plugin_Tag_Call

调用方法 Tag类的魔术方法接口

调用参数 &$tag,$method,$args

Filter_Plugin_Category_Call

调用方法 Category类的魔术方法接口

调用参数 &$category,$method,$args

Filter_Plugin_Member_Call

调用方法 Member类的魔术方法接口

调用参数 &$member,$method,$args

Filter_Plugin_Post_Del

调用方法 Post类的Del方法接口

调用参数 &$post

Filter_Plugin_Tag_Del

调用方法 Tag类的Del方法接口

调用参数 &$post

Filter_Plugin_Comment_Del

调用方法 Comment类的Del方法接口

调用参数 &$comment

Filter_Plugin_Category_Del

调用方法 Category类的Del方法接口

调用参数 &$category

Filter_Plugin_Member_Del

调用方法 Member类的Del方法接口

调用参数 &$member

Filter_Plugin_Module_Del

调用方法 Module类的Del方法接口

调用参数 &$module

Filter_Plugin_Module_Get

调用方法 干预Module类Get方法的接口

调用参数 &$this, $method

Filter_Plugin_Module_Set

调用方法 干预Module类Set方法的接口

调用参数 &$this, $method, $arg

Filter_Plugin_Post_Save

调用方法 Post类的Save方法接口

调用参数 &$post

Filter_Plugin_Comment_Save

调用方法 Comment类的Save方法接口

调用参数 &$comment

Filter_Plugin_Tag_Save

调用方法 Tag类的Save方法接口

调用参数 &$tag

Filter_Plugin_Category_Save

调用方法 Category类的Save方法接口

调用参数 &$category

Filter_Plugin_Member_Save

调用方法 Member类的Save方法接口

调用参数 &$member

Filter_Plugin_Module_Save

调用方法 Module类的Save方法接口

调用参数 &$module

Filter_Plugin_Member_Avatar

调用方法 Member类的Avatar接口

调用参数 $member

Filter_Plugin_Upload_SaveFile

调用方法 Upload类的SaveFile方法接口

调用参数 $tmp,$this

Filter_Plugin_Upload_SaveBase64File

调用方法 Upload类的SaveBase64File方法接口

调用参数 $str64,$this

Filter_Plugin_Upload_DelFile

调用方法 Upload类的DelFile方法接口

调用参数 $this

Filter_Plugin_Upload_Url

调用方法 Upload类的Url方法接口

调用参数 $upload

Filter_Plugin_Upload_Get

调用方法 干预Upload类Get方法的接口

调用参数 &$this, $method

Filter_Plugin_Upload_Set

调用方法 干预Upload类Set方法的接口

调用参数 &$this, $method, $arg

Filter_Plugin_Upload_Dir

调用方法 Upload类的Dir方法接口

调用参数 $upload

Filter_Plugin_App_Pack

调用方法

调用参数

Filter_Plugin_Template_Compiling_Begin

调用方法 Template类编译一个模板前的接口

调用参数 $this,$content

Filter_Plugin_Template_Compiling_End

调用方法 Template类编译一个模板后的接口

调用参数 $this,$content

Filter_Plugin_Template_GetTemplate

调用方法 Template类读取一个模板前的接口

调用参数 $this,$name

Filter_Plugin_Template_Display

调用方法 Template类显示接口

调用参数 $this, $entryPage

大数据操作相关


Filter_Plugin_LargeData_Article

调用方法 大数据文章接口

调用参数 &$select,&$where,&$order,&$limit,&$option

Filter_Plugin_LargeData_Page

调用方法 大数据页面接口

调用参数 &$select,&$where,&$order,&$limit,&$option

Filter_Plugin_LargeData_Comment

调用方法 大数据评论接口

调用参数 &$select,&$where,&$order,&$limit,&$option

Filter_Plugin_LargeData_CountTagArray

调用方法 大数据增减文章标签关联表

调用参数 $string, $plus, $articleid

Filter_Plugin_LargeData_GetList

调用方法 大数据GetList函数

调用参数 &$select,&$where,&$order,&$limit,&$option

其它杂项接口


Filter_Plugin_Xmlrpc_Begin

调用方法 xml-rpc页的begin接口(1.5.1加入)

调用参数 &xml

Filter_Plugin_CSP_Backend

调用方法 后台CSP接口(1.5.2加入)

调用参数 &xml

  • 本页列出Z-BlogPHP系统内部部分插件API接口,开发者可以利用这些接口开发个性化的博客功能。
  • :!:注意,若插件的目的是更改接管系统方法类下的接口参数,应将参数变量通过引用传递给函数。
  • :!:注意:这里信息不全!你需要手动打开zb_system/c_system_plugin.php配合全文搜索来查找接口!

zblogphp/development/plugin/interfaces.1589711840.txt · 最后更改: 2020/05/17 18:37 由 zx.asd