Discuz X 系統：【外掛機制】-【頁面嵌入】詳解

指令碼格式

<?php

//全域性嵌入點類 （必須存在）
class plugin_identifier {

	function HookId_1() {
		......
		return ...;
	}

	function HookId_2() {
		......
		return ...;
	}

	......

}

//指令碼嵌入點類
class plugin_identifier_CURSCRIPT extends plugin_identifier {

	function HookId_1() {
		......
		return ...;
	}

	function HookId_2() {
		......
		return ...;
	}

	......

}

?>

plugin_

普通版指令碼中的類名以 plugin_ 開頭。手機版指令碼中的類名以 mobileplugin_ 開頭。

identifier

外掛的唯一識別符號，在外掛設定中設定。

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>"可搜尋到嵌入點。（詳細內容可參閱的《外掛嵌入點列表》）

$_config['plugindeveloper'] = 2;

預定義的嵌入點會在頁面預置好的位置輸出函式返回的內容。函式返回值型別如果是 array 且是空值的，必須輸出一個空陣列，如：

return array();

函式名並不限於以上列表，您可以自定義，只要符合以下規則，函式就會在適當的地方被呼叫。

function CURMODULE_USERDEFINE[_output]()

CURMODULE 指明瞭此函式在哪個模組執行，可透過常量 CURMODULE 得到當前頁面的 CURMODULE 值。
USERDEFINE
可自定義，如果函式名以「_output」結尾則會在模板輸出前呼叫，否則會在模組執行前呼叫。如：attachment_test()
函式會在論壇的下載附件的時候執行。「_output」結尾的函式的第一個引數為陣列，含義為 array('template' =>
要輸出的模板名, 'message' => showmessage 的文字) 如：以下函式將在登入的時候輸出除錯文字

function logging_test_output($a) {
	print_r($a);
	print_r($_POST);
}

plugin_identifier 類中的其它函式為了便於閱讀建議以「_」開頭，如：

<?php

class plugin_sample {

	function _updatecache() {
		......
		return ...;
	}

}

class plugin_sample_forum extends plugin_sample {

	function viewthread_posttop() {
		......
		return ...;
	}

	......

}

?>

外掛嵌入點列表

全域性 (common/)

 extcredits.htm
     string spacecp_credit_extra
 faq.htm
     string faq_extra
 footer.htm
     string global_footer
     string global_footerlink
 header.htm
     string global_cpnav_top (X2.5)
     string global_cpnav_extra1
     string global_cpnav_extra2
     string global_usernav_extra1
     string global_usernav_extra2
     string global_usernav_extra3
     string global_usernav_extra4 (X2.5)
     string global_nav_extra (X2.5)
     string global_header
 userabout.htm
     array global_userabout_top
     string userapp_menu_top
     string userapp_menu_middle
     array global_userabout_bottom

論壇 (forum/)

 collection_all.htm (X2.5)
     string collection_index_top
     string collection_index_bottom
 collection_comment.htm (X2.5)
     string collection_nav_extra
 collection_index.htm (X2.5)
     string collection_index_top
     string collection_index_bottom
 collection_mycollection.htm (X2.5)
     string collection_index_top
     string collection_index_bottom
 collection_nav.htm (X2.5)
     string collection_nav_extra
 collection_view.htm (X2.5)
     string collection_viewoptions
     string collection_view_top
     string collection_threadlistbottom
     string collection_relatedop
     string collection_view_bottom
     string collection_side_bottom
 discuz.htm
     string index_status_extra
     string index_nav_extra (X2.5)
     string index_top
     string index_catlist_top (X2.5)
     array index_favforum_extra (X2.5)
     array index_catlist (X2.5)
     array index_forum_extra (X2.5)
     array index_forum_extra (X2.5)
     string index_middle
     string index_bottom
     string index_side_top
     string index_side_bottom
 discuzcode.htm
     array viewthread_attach_extra (X2.5)
 editor_menu_forum.htm
     string post_image_btn_extra
     string post_image_tab_extra
     string post_attach_btn_extra
     string post_attach_tab_extra
 forumdisplay.htm
     string forumdisplay_leftside_top
     string forumdisplay_leftside_bottom
     string forumdisplay_forumaction
     string forumdisplay_modlink
     string forumdisplay_top
     string forumdisplay_middle
     string forumdisplay_postbutton_top
     string forumdisplay_threadtype_inner (X2.5)
     string forumdisplay_filter_extra (X2.5)
     string forumdisplay_threadtype_extra (X2.5)
     string forumdisplay_bottom
     string forumdisplay_side_top
     string forumdisplay_side_bottom
 forumdisplay_fastpost.htm
     string forumdisplay_fastpost_content
     string forumdisplay_fastpost_func_extra
     string forumdisplay_fastpost_ctrl_extra
     string global_login_text
     string forumdisplay_fastpost_btn_extra
     string forumdisplay_fastpost_sync_method
 forumdisplay_list.htm
     string forumdisplay_filter_extra
     array forumdisplay_thread
     array forumdisplay_thread_subject (X2.5)
     array forumdisplay_author
     array forumdisplay_thread (X2.5)
     array forumdisplay_author (X2.5)
     string forumdisplay_threadlist_bottom (X2.5)
     string forumdisplay_postbutton_bottom
 forumdisplay_sort.htm (X2.5)
     string forumdisplay_postbutton_bottom
 forumdisplay_subforum.htm (X2.5)
     array forumdisplay_subforum_extra
     array forumdisplay_subforum_extra
 guide.htm
     string guide_nav_extra
     string guide_top
     string guide_bottom
 guide_list_row.htm (X2.5)
     array forumdisplay_thread
 index_navbar.htm
     string index_navbar
 post.htm
     string post_top
     string post_middle
     string post_btn_extra
     string post_sync_method
     string post_bottom
 post_activity.htm
     string post_activity_extra
 post_debate.htm
     string post_debate_extra
 post_editor_body.htm
     string post_editorctrl_right
     string post_editorctrl_left
     string post_editorctrl_top
     string post_editorctrl_bottom
 post_editor_option.htm
     string post_side_top
     string post_side_bottom
 post_infloat.htm
     string post_infloat_top
     string post_infloat_middle
     string post_infloat_btn_extra
 post_poll.htm
     string post_poll_extra
 post_reward.htm
     string post_reward_extra
 post_trade.htm
     string post_trade_extra
 topicadmin_modlayer.htm
     string forumdisplay_modlayer
     string modcp_modlayer
 trade_info.htm
     string viewthread_tradeinfo_extra
 viewthread.htm
     string viewthread_top
     string viewthread_postbutton_top
     string viewthread_modoption
     string viewthread_beginline (X2.5)
     string viewthread_title_extra
     string viewthread_title_row
     string viewthread_middle
     string viewthread_bottom
 viewthread_activity.htm
     string viewthread_activity_extra1
     string viewthread_activity_extra2
 viewthread_fastpost.htm
     string viewthread_fastpost_side
     string viewthread_fastpost_content
     string viewthread_fastpost_func_extra
     string viewthread_fastpost_ctrl_extra
     string global_login_text
     string viewthread_fastpost_btn_extra (X2.5)
 viewthread_from_node.htm
     array viewthread_postheader
     array viewthread_postheader
     array viewthread_postheader
     array viewthread_endline
 viewthread_node.htm
     array viewthread_profileside
     array viewthread_imicons
     array viewthread_magic_user
     array viewthread_avatar
     array viewthread_sidetop
     array viewthread_sidebottom
     array viewthread_postheader
     string viewthread_modaction (X2.5)
     string viewthread_share_method
     string viewthread_useraction
     array viewthread_postsightmlafter (X2.5)
     array viewthread_postfooter
     array viewthread_postaction (X2.5)
     string viewthread_magic_thread
     array viewthread_magic_post
     array viewthread_endline
 viewthread_node_body.htm
     array viewthread_posttop
     string global_login_text
     array viewthread_postbottom
 viewthread_poll.htm
     string viewthread_poll_top
     string viewthread_poll_bottom
 viewthread_portal.htm
     string viewthread_useraction_prefix
     string viewthread_useraction
     string viewthread_side_bottom
 viewthread_trade.htm
     array viewthread_trade_extra

群組 (group/)

 group.htm
     string group_navlink
     string forumdisplay_navlink
     string group_navlink
     string forumdisplay_navlink
     string group_top
     string forumdisplay_top
     string group_nav_extra
     string forumdisplay_nav_extra
     string group_bottom
     string forumdisplay_bottom
     string group_side_bottom
     string forumdisplay_side_bottom
 group_list.htm
     string forumdisplay_postbutton_top
     string forumdisplay_filter_extra
     array forumdisplay_thread
     string forumdisplay_postbutton_bottom
 group_my.htm
     string my_header
     string my_bottom
     string my_side_top
     string my_side_bottom
 group_right.htm
     string group_index_side
     string group_side_top
     string forumdisplay_side_top
 index.htm
     string index_header
     string index_top
     string index_bottom
     string index_side_top
     string index_side_bottom
 type.htm
     string index_top
     array index_grouplist
     string index_bottom
     string index_side_top
     string index_side_bottom

家園 (home/)

 follow_feed.htm (X2.5)
     string follow_nav_extra
     string follow_top
 spacecp_avatar.htm
     string spacecp_avatar_top
     string spacecp_avatar_bottom
 spacecp_blog.htm
     string spacecp_blog_top
     string spacecp_blog_middle
     string spacecp_blog_bottom
 spacecp_credit_base.htm
     string spacecp_credit_top
     string spacecp_credit_extra
     string spacecp_credit_bottom
 spacecp_credit_log.htm
     string spacecp_credit_top
     string spacecp_credit_bottom
 spacecp_privacy.htm
     string spacecp_privacy_top
     string spacecp_privacy_base_extra
     string spacecp_privacy_feed_extra
     string spacecp_privacy_bottom
 spacecp_profile.htm
     string spacecp_profile_top
     string spacecp_profile_extra
     string spacecp_profile_bottom
 spacecp_promotion.htm
     string spacecp_promotion_top
     string spacecp_promotion_bottom
 spacecp_usergroup.htm
     string spacecp_usergroup_top
     string spacecp_usergroup_bottom
     string spacecp_usergroup_top
     string spacecp_usergroup_bottom
     string spacecp_usergroup_top
     string spacecp_usergroup_bottom
 space_album_pic.htm
     string space_album_pic_top
     string space_album_pic_op_extra
     string space_album_pic_bottom
     string space_album_pic_face_extra
 space_album_view.htm
     string space_album_op_extra
 space_blog_list.htm
     array space_blog_list_status
 space_blog_view.htm
     string space_blog_title
     string space_blog_share_method (X2.5)
     string space_blog_op_extra
     string space_blog_face_extra
 space_card.htm
     string space_card_top
     string space_card_baseinfo_middle
     string space_card_baseinfo_bottom
     string space_card_option
     string space_card_magic_user
     string space_card_bottom
 space_comment_li.htm
     array space_blog_comment_op
     string space_blog_comment_bottom
 space_doing.htm
     string space_doing_top
     string space_doing_bottom
 space_favorite.htm (X2.5)
     string space_favorite_nav_extra
 space_friend.htm
     string space_interaction_extra
 space_header.htm
     string global_usernav_extra1
     string global_usernav_extra2
 space_home.htm
     string space_home_side_top (X2.5)
     string space_home_side_bottom
     string space_home_top
     string space_home_navlink
     string space_home_bottom
 space_magic.htm (X2.5)
     string magic_nav_extra
 space_medal.htm (X2.5)
     string medal_nav_extra
 space_menu.htm
     string space_menu_extra
 space_profile_body.htm
     string space_profile_baseinfo_top
     string follow_profile_baseinfo_top (X2.5)
     string space_profile_baseinfo_middle
     string follow_profile_baseinfo_middle (X2.5)
     string space_profile_baseinfo_bottom
     string follow_profile_baseinfo_bottom (X2.5)
     string space_profile_extrainfo
     string follow_profile_extrainfo (X2.5)
 space_share_li.htm
     array space_share_comment_op
 space_status.htm
     string space_home_doing_sync_method
 space_wall.htm
     string space_wall_face_extra

註冊/登入 (member/)

 login.htm
     string logging_side_top
     string logging_top
     string logging_input
     string logging_method
 login_simple.htm
     string global_login_extra
 register.htm
     string register_side_top
     string register_top
     string register_input
     string register_logging_method
     string register_bottom

門戶 (portal/)

 portalcp_article.htm
     string portalcp_top
     string portalcp_extend
     string portalcp_middle
     string portalcp_bottom
 view.htm
     string view_article_top (X2.5)
     string view_article_subtitle (X2.5)
     string view_article_summary (X2.5)
     string view_article_content (X2.5)
     string view_share_method
     string view_article_op_extra (X2.5)
     string view_article_side_top (X2.5)
     string view_article_side_bottom (X2.5)

排行榜 (ranklist/)

 side_left.htm
     string ranklist_nav_extra

搜尋 (search/)

 album.htm
     string album_top
     string album_bottom
 blog.htm
     string blog_top
     string blog_bottom
 footer.htm
     string global_footer
     string global_footerlink
 forum.htm
     string forum_top
     string forum_bottom
 group.htm
     string group_top
     string group_bottom
 header.htm
     string global_usernav_extra1
     string global_usernav_extra2
 portal.htm
     string portal_top
     string portal_bottom

應用 (userapp/)

 userapp_app.htm
     string userapp_app_top
     string userapp_app_bottom
 userapp_index.htm
     string userapp_index_top
     string userapp_index_bottom
 userapp_menu_list.htm
     string userapp_menu_top
     string userapp_menu_middle
     string userapp_menu_bottom

手機全域性 (mobile/common/)

 footer.htm
     string global_footer_mobile
 header.htm
     string global_header_mobile

手機論壇 (mobile/forum/)

 discuz.htm
     string index_top_mobile
     string index_middle_mobile
     string index_bottom_mobile
 forumdisplay.htm
     string forumdisplay_top_mobile
     array forumdisplay_thread_mobile
     string forumdisplay_bottom_mobile
 viewthread.htm
     string viewthread_top_mobile
     array viewthread_posttop_mobile
     array viewthread_postbottom_mobile
     string viewthread_bottom_mobile

Discuz X 系統：【外掛機制】-【頁面嵌入】詳解