php版zblog主题插件开发常用系统接口汇总列表

zblog教程 281

在进行 zblog 主题或 zblog 插件开发中,一些功能模块免不了调用相关的 zblog 系统接口,因此为了应对各种各样的扩展需求,Z-Blog PHP 提供了一系列的插件接口供应用开发者使用,并在整体上把接口划分为管理页面输出类、接管系统方法类、魔术方法类、前台页面输出类几大类,可根据不同的需求选择调用。

接口分类说明

管理页面输出类

这一类接口一般用于在后台现有管理页面中添加按钮或者扩展选项内容

接管系统方法类

系统方法接管的位置一般有两种:

  1. Core:在数据提交前介入,可用于过滤提交的数据内容
  2. Succeed:在数据提交成功后介入,可用于数据提交后的事件处理,如更新自定义模块数据等
魔术方法类

用于扩展系统类中的可用方法

前台页面输出类

如首页的起始、结尾,列表、文章、搜索页面等等起始位置,添加脚本等

TC唐朝版接口

这是zblog应用开发者唐朝整理的Z-BlogPHP系统内部部分插件API接口,开发者可以利用这些接口开发个性化的博客功能。

注意:
  • 若插件的目的是更改接管系统方法类下的接口参数,应将参数变量通过引用传递给函数。
  • 这里信息不全!你需要手动打开zb_system/c_system_plugin.php配合全文搜索来查找接口!
文章相关接口

1、管理页面输出

接口名称 接口参数 接口描述
filter_plugin_admin_articlemng_submenu 文章管理子菜单
filter_plugin_admin_pagemng_submenu 页面管理子菜单
filter_plugin_edit_begin 文章页面编辑页开始接口
filter_plugin_edit_end 文章页面编辑页结束接口
filter_plugin_edit_response 文章页面编辑1号输出接口
filter_plugin_edit_response2 文章页面编辑2号输出接口
filter_plugin_edit_response3 文章页面编辑3号输出接口

2、接管系统方法

接口名称 接口参数 接口描述
Filter_Plugin_PostArticle_Core article 文章提交的核心接口
Filter_Plugin_PostArticle_Succeed article 文章编辑成功的接口
Filter_Plugin_DelArticle_Succeed article 文章删除成功的接口
Filter_Plugin_PostPage_Core article 页面编辑的核心接口
Filter_Plugin_PostPage_Succeed article 页面编辑成功的接口
Filter_Plugin_DelPage_Succeed article 页面删除成功的接口
Filter_Plugin_Post_Call post,method,args Post类的魔术方法接口
分类相关接口

1、管理页面输出

接口名称 接口参数 接口描述
Filter_Plugin_Admin_CategoryMng_SubMenu 分类管理页面子菜单
Filter_Plugin_Category_Edit_Response 分类编辑页输出接口

2、接管系统方法

接口名称 接口参数 接口描述
Filter_Plugin_PostCategory_Core cate 分类编辑的核心接口
Filter_Plugin_PostCategory_Succeed cate 分类编辑成功的接口
Filter_Plugin_DelCategory_Succeed cate 分类删除成功的接口
Filter_Plugin_Category_Call category,method,args Category类的魔术方法接口
评论接口
接口名称 接口参数 接口描述
Filter_Plugin_Admin_CommentMng_SubMenu 评论管理页面子菜单
Filter_Plugin_PostComment_Core cmt 评论发表的核心接口
Filter_Plugin_PostComment_Succeed cmt 评论发表成功的接口
Filter_Plugin_CheckComment_Core cmt 评论审核的核心接口
Filter_Plugin_CheckComment_Succeed cmt 评论审核成功的接口
Filter_Plugin_DelComment_Succeed cmt 评论删除成功的接口
Filter_Plugin_Comment_Call comment,method,args Comment类的魔术方法接口
用户接口
接口名称 接口参数 接口描述
Filter_Plugin_Admin_MemberMng_SubMenu 用户管理
Filter_Plugin_Member_Edit_Response 会员编辑页输出接口
Filter_Plugin_PostMember_Core mem 会员编辑的核心接口
Filter_Plugin_PostMember_Succeed mem 会员编辑成功的接口
Filter_Plugin_DelMember_Succeed mem 会员删除成功的接口
Filter_Plugin_Member_Call member,method,args Member类的魔术方法接口
Filter_Plugin_Mebmer_Avatar member Mebmer类的Avatar接口
附件接口
接口名称 接口参数 接口描述
Filter_Plugin_Admin_UploadMng_SubMenu
Filter_Plugin_Upload_SaveFile tmp Upload类的SaveFile方法接口
Filter_Plugin_Upload_SaveBase64File str64 Upload类的SaveBase64File方法接口
Filter_Plugin_Upload_Url upload Upload类的Url方法接口
标签接口
接口名称 接口参数 接口描述
Filter_Plugin_Admin_TagMng_SubMenu 标签管理
Filter_Plugin_Tag_Edit_Response 标签编辑页输出接口
Filter_Plugin_PostTag_Core tag 标签编辑的核心接口
Filter_Plugin_PostTag_Succeed tag 标签编辑成功的接口
Filter_Plugin_DelTag_Succeed tag 标签删除成功的接口
Filter_Plugin_Tag_Call tag,method,args Tag类的魔术方法接口
主题接口
接口名称 接口参数 接口描述
Filter_Plugin_Admin_ThemeMng_SubMenu 主题管理
插件接口
接口名称 接口参数 接口描述
Filter_Plugin_Admin_PluginMng_SubMenu 插件管理
模块接口
接口名称 接口参数 接口描述
Filter_Plugin_Admin_ModuleMng_SubMenu 模块管理
Filter_Plugin_PostModule_Core mod 模块编辑的核心接口
Filter_Plugin_PostModule_Succeed mod 模块编辑成功的接口
Filter_Plugin_DelModule_Succeed mod 模块删除成功的接口
浏览接口
接口名称 接口参数 接口描述
Filter_Plugin_Index_Begin 定义index.php接口 起动
Filter_Plugin_Index_End 定义index.php接口 结束
Filter_Plugin_Html_Js_Add c_html_js_add.php脚本调用,JS页接口需要强制开启
Filter_Plugin_Search_Begin 搜索页接口,可以接管搜索页。
Filter_Plugin_Feed_Begin Feed页接口,可以接管Feed页。
Filter_Plugin_ViewAuto_Begin url 定义列表输出接口
Filter_Plugin_ViewList_Begin page,cate,auth,date,tags 定义列表输出接口
Filter_Plugin_ViewPost_Begin id,alias 定义列表输出接口
Filter_Plugin_ViewList_Template template 处理列表页模板接口
Filter_Plugin_ViewPost_Template template 处理文章页模板接口
Filter_Plugin_ViewComments_Template template 处理评论模板接口
系统接口
接口名称 接口参数 接口描述
Filter_Plugin_Autoload classname 定义autoload魔术方法
Filter_Plugin_Zbp_Call method, args Zbp类的魔术方法接口
Filter_Plugin_Zbp_CheckRights action Zbp类的检查权限接口(检查当前用户)
Filter_Plugin_Zbp_CheckRightsByLevel level,action Zbp类的检查权限接口(检查指定level)
Filter_Plugin_Zbp_ShowError idortext Zbp类的显示错误接口
Filter_Plugin_Zbp_BuildTemplate template Zbp类的重新编译模板接口
Filter_Plugin_Zbp_MakeTemplatetags template Zbp类的生成模板标签接口
Filter_Plugin_Zbp_BuildModule Zbp类的生成模块内容的接口
Filter_Plugin_Zbp_Load Zbp类的初始加载接口
Filter_Plugin_Zbp_Terminate Zbp类的终结接口
Filter_Plugin_Cmd_Begin cmd.php的启动接口,可以在这里拦截各种action
其他
接口名称 接口参数 接口描述
Filter_Plugin_Admin_Begin 后台管理页的启动接口,可以拦截后台管理请求实现自己的管理
Filter_Plugin_Admin_Header 定义后台首页header接口
Filter_Plugin_Admin_Footer 定义后台首页footer接口
Filter_Plugin_Admin_LeftMenu leftmenus 定义后台左侧栏接口
Filter_Plugin_Admin_TopMenu topmenus 定义后台顶部导航栏接口
Filter_Plugin_Admin_SiteInfo_SubMenu 后台首页SubMenu
Filter_Plugin_Admin_SettingMng_SubMenu 设置管理
Filter_Plugin_Admin_Js_Add c_admin_js_add.php脚本页的接口

部分接口的使用有示例,可以访问原文:https://wiki.zblogcn.com/doku.php?id=zblogphp:development:plugin:interfacestc

更多接口可访问:https://wiki.zblogcn.com/doku.php?id=zblogphp:development:plugin:interfaces

精品推荐: