这是本文档旧的修订版!
目录
插件接口及功能列表
默认接口
在Typecho中只要这个类是继承自Typecho_Widget基类,它就默认具备了这个插件接口。接口开发者可以使用这个接口无缝地向当前的Class中注入方法
比如我要给Widget_Archive类增加一个方法获取当前文章的字数(charactersNum),只需要在你的插件`activate`方法中声明
Typecho_Plugin::factory('Widget_Archive')->___charactersNum = array('MyPlugin', 'charactersNum');
注意,我们在方法名前面加三个下划线表示这是一个内部方法。而实现这个方法也很简单,因为系统会将当前的对象作为参数传递给你
public static function charactersNum($archive) { return mb_strlen($archive->text, 'UTF-8'); }
那么这个方法就已经植入到Widget_Archive中去了,你在模版中可以直接调用如下代码输出它
<?php $this->charactersNum(); ?>
Widget接口
Widget_Archive
接口 | 参数 | 描述 |
---|---|---|
indexHandle |
|
|
error404Handle |
|
|
singleHandle |
|
|
categoryHandle |
|
|
tagHandle |
|
|
authorHandle |
|
|
dateHandle |
|
|
search |
|
|
searchHandle |
|
|
query |
|
|
select |
|
|
handleInit |
|
|
handle |
|
|
pageNav |
|
|
headerOptions |
|
|
header |
|
|
footer |
|
|
beforeRender |
|
|
afterRender |
|
|
commentFeedItem |
|
|
feedItem |
|
Widget_Feedback
接口 | 参数 | 描述 |
---|---|---|
comment |
|
|
finishComment |
|
|
trackback |
|
|
finishTrackback |
|
Widget_Login
接口 | 参数 | 描述 |
---|---|---|
loginFail |
|
|
loginSucceed |
|
Widget_Logout
接口 | 参数 | 描述 |
---|---|---|
logout |
无 |
Widget_Register
接口 | 参数 | 描述 |
---|---|---|
register |
|
|
finishRegister |
|
Widget_Upload
接口 | 参数 | 描述 |
---|---|---|
beforeUpload |
|
|
upload |
|
|
beforeModify |
|
|
modify |
|
Widget_User
接口 | 参数 | 描述 |
---|---|---|
login |
|
|
hashValidate |
|
|
loginSucceed |
|
|
loginFail |
|
|
logout |
无 |
Widget_XmlRpc
接口 | 参数 | 描述 |
---|---|---|
textFilter |
|
|
upload |
|
|
pingback |
|
|
finishPingback |
|
Widget_Abstract_Comments
接口 | 参数 | 描述 |
---|---|---|
content |
|
以下句柄同样具有此接口:
|
contentEx |
|
以下句柄同样具有此接口:
|
filter |
|
以下句柄同样具有此接口:
|
gravatar |
|
以下句柄同样具有此接口:
|
autoP |
|
以下句柄同样具有此接口:
|
markdown |
|
以下句柄同样具有此接口:
|
Widget_Abstract_Contents
接口 | 参数 | 描述 |
---|---|---|
excerpt |
|
以下句柄同样具有此接口:
|
excerptEx |
|
以下句柄同样具有此接口:
|
content |
|
以下句柄同样具有此接口:
|
contentEx |
|
以下句柄同样具有此接口:
|
isFieldReadOnly |
|
以下句柄同样具有此接口:
|
filter |
|
以下句柄同样具有此接口:
|
title |
|
以下句柄同样具有此接口:
|
autoP |
|
以下句柄同样具有此接口:
|
markdown |
|
以下句柄同样具有此接口:
|
Widget_Abstract_Metas
接口 | 参数 | 描述 |
---|---|---|
filter |
|
以下句柄同样具有此接口:
|
Widget_Abstract_Users
接口 | 参数 | 描述 |
---|---|---|
filter |
|
以下句柄同样具有此接口:
|
Widget_Comments_Archive
接口 | 参数 | 描述 |
---|---|---|
listComments |
|
|
reply |
|
|
cancelReply |
|
Widget_Comments_Edit
接口 | 参数 | 描述 |
---|---|---|
mark |
|
|
delete |
|
|
finishDelete |
|
|
edit |
|
|
finishEdit |
|
|
comment |
|
|
finishComment |
|
Widget_Contents_Attachment_Edit
接口 | 参数 | 描述 |
---|---|---|
delete |
|
|
finishDelete |
|
|
delete |
|
|
finishDelete |
|
Widget_Contents_Page_Edit
接口 | 参数 | 描述 |
---|---|---|
write |
|
|
finishPublish |
|
|
finishSave |
|
|
delete |
|
|
finishDelete |
|
Widget_Contents_Post_Edit
接口 | 参数 | 描述 |
---|---|---|
getDefaultFieldItems |
|
以下句柄同样具有此接口:
|
write |
|
以下句柄同样具有此接口:
|
finishPublish |
|
以下句柄同样具有此接口:
|
finishSave |
|
以下句柄同样具有此接口:
|
delete |
|
以下句柄同样具有此接口:
|
finishDelete |
|
以下句柄同样具有此接口:
|
Widget_Metas_Category_List
接口 | 参数 | 描述 |
---|---|---|
listCategories |
|
以下句柄同样具有此接口:
|