Typecho 官方文檔接口介紹

時間 2019-11-13

標籤 typecho 官方文檔接口介紹简体版

原文原文鏈接

官方開發文檔實在是太潦草了

Widget_Archive

接口	參數	描述
`indexHandle`	`$archive` Widget_Archive對象 `$select` Typecho_Db_Query對象	當訪問最近文章首頁以及分頁時被觸發
`error404Handle`	`$archive` Widget_Archive對象 `$select` Typecho_Db_Query對象	當訪問404頁面時被觸發
`singleHandle`	`$archive` Widget_Archive對象 `$select` Typecho_Db_Query對象	當訪問單獨頁面時被觸發(文章，頁面，附件)
`categoryHandle`	`$archive` Widget_Archive對象 `$select` Typecho_Db_Query對象	當訪問按分類歸檔頁面時被觸發
`tagHandle`	`$archive` Widget_Archive對象 `$select` Typecho_Db_Query對象	當訪問按標籤歸檔頁面時被觸發
`authorHandle`	`$archive` Widget_Archive對象 `$select` Typecho_Db_Query對象	當訪問按做者歸檔頁面時被觸發
`dateHandle`	`$archive` Widget_Archive對象 `$select` Typecho_Db_Query對象	當訪問按日期歸檔頁面時被觸發
`search`	`$keywords` 搜索關鍵詞 `$archive` Widget_Archive對象	這是一個獨佔接口，當訪問搜索頁面時被觸發當這個接口被實現後，系統本身的搜索動做將不會繼續，你須要在這個接口內本身push搜索的數據到Widget_Archive對象此接口多用於本身實現站內搜索來替換默認的
`searchHandle`	`$archive` Widget_Archive對象 `$select` Typecho_Db_Query對象	當訪問搜索頁面時被觸發
`query`	`$archive` Widget_Archive對象 `$select` Typecho_Db_Query對象	Widget_Archive全部的數據庫查詢動做最終將由一個query方法來執行此接口在query方法內，多用於hack某些查詢語句
`select`	`$archive` Widget_Archive對象
`handleInit`	`$archive` Widget_Archive對象 `$select` Typecho_Db_Query對象
`handle`	`type` `$archive` Widget_Archive對象 `$select` Typecho_Db_Query對象
`pageNav`	`currentPage` `$total` `pageSize` `$prev` `$next` `$splitPage` `$splitWord`
`headerOptions`	`$allows` `$archive` Widget_Archive對象
`header`	`$header` `$archive` Widget_Archive對象	首頁與文章頁頭部
`footer`	`$archive` Widget_Archive對象	首頁與文章頁腳部
`beforeRender`	`$archive` Widget_Archive對象
`afterRender`	`$archive` Widget_Archive對象
`commentFeedItem`	`feedType` `$comments`
`feedItem`	`feedType` `$archive` Widget_Archive對象

Widget_Feedback

接口	參數	描述
`comment`	`$comment` `content`
`finishComment`	`$feedback` Widget_Feedback對象
`trackback`	`$trackback` `content`
`finishTrackback`	`$feedback` Widget_Feedback對象	評論成功時觸發

Widget_Login

接口	參數	描述
`loginFail`	`user` `name` `password` `remember`
`loginSucceed`	`user` `name` `password` `remember`

Widget_Logout

接口	參數	描述
`logout`	無

Widget_Register

接口	參數	描述
`register`	`$dataStruct`
`finishRegister`	`$register` Widget_Register對象

Widget_Upload

接口	參數	描述
`beforeUpload`	`$result`
`upload`	`$upload` Widget_Upload對象
`beforeModify`	`$result`
`modify`	`$upload` Widget_Upload對象

Widget_User

接口	參數	描述
`login`	`$name` `$password` `$temporarily` `$expire`
`hashValidate`	`$password` `$user['password']`
`loginSucceed`	`$user` Widget_User對象 `$name` `$password` `$temporarily` `$expire`
`loginFail`	`$user` Widget_User對象 `$name` `$password` `$temporarily` `$expire`
`logout`	無

Widget_XmlRpc

接口	參數	描述
`textFilter`	`$input['text']` `$xmlRpc` Widget_XmlRpc對象
`upload`	`$xmlRpc` Widget_XmlRpc對象
`pingback`	`$pingback` `$post`
`finishPingback`	`$xmlRpc` Widget_XmlRpc對象

Widget_Abstract_Comments

接口	參數	描述
`content`	`$text` `$comments` Widget_Abstract_Comments對象	如下句柄一樣具備此接口: `Widget_Feedback` `Widget_Comments_Admin` `Widget_Comments_Archive` `Widget_Comments_Edit` `Widget_Comments_Ping` `Widget_Comments_Recent`
`contentEx`	`$text` `$comments` Widget_Abstract_Comments對象	如下句柄一樣具備此接口: `Widget_Feedback` `Widget_Comments_Admin` `Widget_Comments_Archive` `Widget_Comments_Edit` `Widget_Comments_Ping` `Widget_Comments_Recent`
`filter`	`$value` `$comments` Widget_Abstract_Comments對象	如下句柄一樣具備此接口: `Widget_Feedback` `Widget_Comments_Admin` `Widget_Comments_Archive` `Widget_Comments_Edit` `Widget_Comments_Ping` `Widget_Comments_Recent`
`gravatar`	`$size` `$rating` `$default` `$comments` Widget_Abstract_Comments對象	如下句柄一樣具備此接口: `Widget_Feedback` `Widget_Comments_Admin` `Widget_Comments_Archive` `Widget_Comments_Edit` `Widget_Comments_Ping` `Widget_Comments_Recent`
`autoP`	`$text`	如下句柄一樣具備此接口: `Widget_Feedback` `Widget_Comments_Admin` `Widget_Comments_Archive` `Widget_Comments_Edit` `Widget_Comments_Ping` `Widget_Comments_Recent`
`markdown`	`$text`	如下句柄一樣具備此接口: `Widget_Feedback` `Widget_Comments_Admin` `Widget_Comments_Archive` `Widget_Comments_Edit` `Widget_Comments_Ping` `Widget_Comments_Recent`

Widget_Abstract_Contents

接口	參數	描述
`excerpt`	`text` `$contents` Widget_Abstract_Contents對象	如下句柄一樣具備此接口: `Widget_Archive` `Widget_Upload` `Widget_XmlRpc` `Widget_Contents_Related` `Widget_Contents_Attachment_Admin` `Widget_Contents_Attachment_Related` `Widget_Contents_Attachment_Unattached` `Widget_Contents_Page_List` `Widget_Contents_Post_Admin` `Widget_Contents_Page_Admin` `Widget_Contents_Post_Edit` `Widget_Contents_Attachment_Edit` `Widget_Contents_Page_Edit` `Widget_Contents_Post_Recent` `Widget_Contents_Related_Author`
`excerptEx`	`$excerpt` `$contents` Widget_Abstract_Contents對象	如下句柄一樣具備此接口: `Widget_Archive` `Widget_Upload` `Widget_XmlRpc` `Widget_Contents_Related` `Widget_Contents_Attachment_Admin` `Widget_Contents_Attachment_Related` `Widget_Contents_Attachment_Unattached` `Widget_Contents_Page_List` `Widget_Contents_Post_Admin` `Widget_Contents_Page_Admin` `Widget_Contents_Post_Edit` `Widget_Contents_Attachment_Edit` `Widget_Contents_Page_Edit` `Widget_Contents_Post_Recent` `Widget_Contents_Related_Author`
`content`	`text` `$contents` Widget_Abstract_Contents對象	如下句柄一樣具備此接口: `Widget_Archive` `Widget_Upload` `Widget_XmlRpc` `Widget_Contents_Related` `Widget_Contents_Attachment_Admin` `Widget_Contents_Attachment_Related` `Widget_Contents_Attachment_Unattached` `Widget_Contents_Page_List` `Widget_Contents_Post_Admin` `Widget_Contents_Page_Admin` `Widget_Contents_Post_Edit` `Widget_Contents_Attachment_Edit` `Widget_Contents_Page_Edit` `Widget_Contents_Post_Recent` `Widget_Contents_Related_Author`
`contentEx`	`$content` `$contents` Widget_Abstract_Contents對象	如下句柄一樣具備此接口: `Widget_Archive` `Widget_Upload` `Widget_XmlRpc` `Widget_Contents_Related` `Widget_Contents_Attachment_Admin` `Widget_Contents_Attachment_Related` `Widget_Contents_Attachment_Unattached` `Widget_Contents_Page_List` `Widget_Contents_Post_Admin` `Widget_Contents_Page_Admin` `Widget_Contents_Post_Edit` `Widget_Contents_Attachment_Edit` `Widget_Contents_Page_Edit` `Widget_Contents_Post_Recent` `Widget_Contents_Related_Author`
`isFieldReadOnly`	`$name`	如下句柄一樣具備此接口: `Widget_Archive` `Widget_Upload` `Widget_XmlRpc` `Widget_Contents_Related` `Widget_Contents_Attachment_Admin` `Widget_Contents_Attachment_Related` `Widget_Contents_Attachment_Unattached` `Widget_Contents_Page_List` `Widget_Contents_Post_Admin` `Widget_Contents_Page_Admin` `Widget_Contents_Post_Edit` `Widget_Contents_Attachment_Edit` `Widget_Contents_Page_Edit` `Widget_Contents_Post_Recent` `Widget_Contents_Related_Author`
`filter`	`$value` `$contents` Widget_Abstract_Contents對象	如下句柄一樣具備此接口: `Widget_Archive` `Widget_Upload` `Widget_XmlRpc` `Widget_Contents_Related` `Widget_Contents_Attachment_Admin` `Widget_Contents_Attachment_Related` `Widget_Contents_Attachment_Unattached` `Widget_Contents_Page_List` `Widget_Contents_Post_Admin` `Widget_Contents_Page_Admin` `Widget_Contents_Post_Edit` `Widget_Contents_Attachment_Edit` `Widget_Contents_Page_Edit` `Widget_Contents_Post_Recent` `Widget_Contents_Related_Author`
`title`	`title` `$contents` Widget_Abstract_Contents對象	如下句柄一樣具備此接口: `Widget_Archive` `Widget_Upload` `Widget_XmlRpc` `Widget_Contents_Related` `Widget_Contents_Attachment_Admin` `Widget_Contents_Attachment_Related` `Widget_Contents_Attachment_Unattached` `Widget_Contents_Page_List` `Widget_Contents_Post_Admin` `Widget_Contents_Page_Admin` `Widget_Contents_Post_Edit` `Widget_Contents_Attachment_Edit` `Widget_Contents_Page_Edit` `Widget_Contents_Post_Recent` `Widget_Contents_Related_Author`
`autoP`	`$text`	如下句柄一樣具備此接口: `Widget_Archive` `Widget_Upload` `Widget_XmlRpc` `Widget_Contents_Related` `Widget_Contents_Attachment_Admin` `Widget_Contents_Attachment_Related` `Widget_Contents_Attachment_Unattached` `Widget_Contents_Page_List` `Widget_Contents_Post_Admin` `Widget_Contents_Page_Admin` `Widget_Contents_Post_Edit` `Widget_Contents_Attachment_Edit` `Widget_Contents_Page_Edit` `Widget_Contents_Post_Recent` `Widget_Contents_Related_Author`
`markdown`	`$text`	如下句柄一樣具備此接口: `Widget_Archive` `Widget_Upload` `Widget_XmlRpc` `Widget_Contents_Related` `Widget_Contents_Attachment_Admin` `Widget_Contents_Attachment_Related` `Widget_Contents_Attachment_Unattached` `Widget_Contents_Page_List` `Widget_Contents_Post_Admin` `Widget_Contents_Page_Admin` `Widget_Contents_Post_Edit` `Widget_Contents_Attachment_Edit` `Widget_Contents_Page_Edit` `Widget_Contents_Post_Recent` `Widget_Contents_Related_Author`

Widget_Abstract_Metas

接口	參數	描述
`filter`	`$value` `$metas` Widget_Abstract_Metas對象	如下句柄一樣具備此接口: `Widget_Metas_Category_Edit` `Widget_Metas_Category_List` `Widget_Metas_Category_Admin` `Widget_Metas_Tag_Cloud` `Widget_Metas_Tag_Admin` `Widget_Metas_Tag_Edit`

Widget_Abstract_Users

接口	參數	描述
`filter`	`$value` `$users` Widget_Abstract_Users對象	如下句柄一樣具備此接口: `Widget_Login` `Widget_Logout` `Widget_Register` `Widget_Users_Admin` `Widget_Users_Author` `Widget_Users_Edit` `Widget_Users_Profile`

Widget_Comments_Archive

接口	參數	描述
`listComments`	`singleCommentOptions` `$archive` Widget_Comments_Archive對象
`reply`	`$word` `$archive` Widget_Comments_Archive對象
`cancelReply`	`$word` `$archive` Widget_Comments_Archive對象

Widget_Comments_Edit

接口	參數	描述
`mark`	`$comment` `$edit` Widget_Comments_Edit對象 `$status`
`delete`	`$comment` `$edit` Widget_Comments_Edit對象
`finishDelete`	`$comment` `$edit` Widget_Comments_Edit對象
`edit`	`$comment` `$edit` Widget_Comments_Edit對象
`finishEdit`	`$edit` Widget_Comments_Edit對象
`comment`	`$comment` `$edit` Widget_Comments_Edit對象
`finishComment`	`$edit` Widget_Comments_Edit對象

Widget_Contents_Attachment_Edit

接口	參數	描述
`delete`	`$post` `$edit` Widget_Contents_Attachment_Edit對象
`finishDelete`	`$post` `$edit` Widget_Contents_Attachment_Edit對象
`delete`	`$post` `$edit` Widget_Contents_Attachment_Edit對象
`finishDelete`	`$post` `$edit` Widget_Contents_Attachment_Edit對象

Widget_Contents_Page_Edit

接口	參數	描述
`write`	`$contents` `$edit` Widget_Contents_Page_Edit對象
`finishPublish`	`$contents` `$edit` Widget_Contents_Page_Edit對象
`finishSave`	`$contents` `$edit` Widget_Contents_Page_Edit對象
`delete`	`$page` `$edit` Widget_Contents_Page_Edit對象
`finishDelete`	`$page` `$edit` Widget_Contents_Page_Edit對象

Widget_Contents_Post_Edit

接口	參數	描述
`getDefaultFieldItems`	`$layout`	如下句柄一樣具備此接口: `Widget_Contents_Attachment_Edit` `Widget_Contents_Page_Edit`
`write`	`$contents` `$edit` Widget_Contents_Post_Edit對象	如下句柄一樣具備此接口: `Widget_Contents_Attachment_Edit` `Widget_Contents_Page_Edit`
`finishPublish`	`$contents` `$edit` Widget_Contents_Post_Edit對象	如下句柄一樣具備此接口: `Widget_Contents_Attachment_Edit` `Widget_Contents_Page_Edit`
`finishSave`	`$contents` `$edit` Widget_Contents_Post_Edit對象	如下句柄一樣具備此接口: `Widget_Contents_Attachment_Edit` `Widget_Contents_Page_Edit`
`delete`	`$post` `$edit` Widget_Contents_Post_Edit對象	如下句柄一樣具備此接口: `Widget_Contents_Attachment_Edit` `Widget_Contents_Page_Edit`
`finishDelete`	`$post` `$edit` Widget_Contents_Post_Edit對象	如下句柄一樣具備此接口: `Widget_Contents_Attachment_Edit` `Widget_Contents_Page_Edit`