Z-BlogPHP 开发文档:开发应用接口列表


接口分类

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

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

  • 「前台页面」输出类:在网页内容输出到浏览器前进行变更或追加,包括额外引入样式、脚本。

  • 「数据写入」处理类:在文章、评论等数据提交的过程中,具体又分为:

    • Core:在数据提交前介入,可用于过滤提交的数据内容。

    • Succeed:在数据提交成功后介入,可用于数据提交后的事件处理,如更新自定义模块数据等。

  • 「魔术方法」扩展类:用于扩展系统类中的可用方法

  • 「流程/事件」监听类:严格来说,全部接口都是「监听」,监听接口本身被触发,然后执行指定的操作,或者对接口传递的数据进行处理。

    • 除「魔术方法」外,前三种是类别其实是以「功能目的」来划分的,也只是较常用的三种。

注:下边列表并不严格对应上边分类;

「管理页面」输出

后台全局输出

接口参数说明
Filter_Plugin_Admin_Header   用于向后台「header」输出内容
Filter_Plugin_Admin_Footer   用于向后台「footer」输出内容
Filter_Plugin_Admin_TopMenu arr $topmenus 用于向后台「顶部菜单」添加项目
Filter_Plugin_Admin_LeftMenu arr $leftmenus 用于向后台「侧栏菜单」添加项目

接口示例

function ActivePlugin_curApp() {
   Add_Filter_Plugin('Filter_Plugin_Admin_Header','curApp_Admin_Header');
   Add_Filter_Plugin('Filter_Plugin_Admin_TopMenu','curApp_Admin_TopMenu'); 
} 
function curApp_Admin_Header() {
   global $zbp;   
   echo '';   
   echo ''; 
} function curApp_Admin_TopMenu(&$topmenus) {
   global $zbp;   
   $topmenus[] = MakeTopMenu("root", "curApp管理", $zbp->host . "zb_users/plugin/curApp/main.php", "", ""); 
} 
// Filter_Plugin_Admin_Footer 和 Filter_Plugin_Admin_LeftMenu 同理; // 对应有 MakeLeftMenu() 函数可用

特定页 SubMenu

接口参数说明
Filter_Plugin_Admin_SiteInfo_SubMenu    
Filter_Plugin_Admin_ArticleMng_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    
Filter_Plugin_Tag_Edit_SubMenu    
Filter_Plugin_Module_Edit_SubMenu    
Filter_Plugin_Member_Edit_SubMenu    
Filter_Plugin_Category_Edit_SubMenu    

特定页表格过滤

接口参数说明
Filter_Plugin_Admin_ArticleMng_Table    
Filter_Plugin_Admin_PageMng_Table    
Filter_Plugin_Admin_CategoryMng_Table    
Filter_Plugin_Admin_CommentMng_Table    
Filter_Plugin_Admin_MemberMng_Table    
Filter_Plugin_Admin_UploadMng_Table    
Filter_Plugin_Admin_TagMng_Table    

特定页输出

接口参数说明
Filter_Plugin_Edit_Begin    
Filter_Plugin_Edit_End    
Filter_Plugin_Edit_Response    
Filter_Plugin_Edit_Response2    
Filter_Plugin_Edit_Response4    
Filter_Plugin_Edit_Response5    
Filter_Plugin_Edit_Response3    
Filter_Plugin_Category_Edit_Response    
Filter_Plugin_Tag_Edit_Response    
Filter_Plugin_Member_Edit_Response    
Filter_Plugin_Module_Edit_Response    

「管理页面」流程监听

接口参数说明
Filter_Plugin_Admin_Begin    
Filter_Plugin_Admin_End    

「前台页面」输出

接口参数说明
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_Index_Begin    
Filter_Plugin_Index_End    
Filter_Plugin_ViewIndex_Begin str $url  
Filter_Plugin_ViewAuto_Begin str $inpurl,str $url  
Filter_Plugin_ViewAuto_End str $url  
Filter_Plugin_Feed_Begin    
Filter_Plugin_Feed_End    
Filter_Plugin_ViewFeed_Begin    
Filter_Plugin_ViewFeed_Core arr $w  
Filter_Plugin_ViewFeed_End obj $rss2  
Filter_Plugin_ViewList_Begin    
Filter_Plugin_ViewList_Core    
Filter_Plugin_Search_Begin    
Filter_Plugin_Search_End    
Filter_Plugin_ViewSearch_Begin    
Filter_Plugin_ViewSearch_Core    
Filter_Plugin_ViewPost_Begin    
Filter_Plugin_ViewPost_Core $select, $w, $order, $limit, $option  

本文来源:https://www.newbii.cn/zblog/dev-interfaces