WordPress 插件API:过滤器Filter参考(一)

本文包含一个广泛的(但不是100%全面的)列表,列出了WordPress 2.1版和更高版本的插件开发中可用的过滤器钩子。有关详细信息,请参阅:

注意:如果您想要添加或澄清本文档,请遵循现有条目的样式。描述filter应用于哪些数据,如果filter函数接受其他参数,请描述参数列表。

文章、页面和附件(上传)过滤器Filter

数据库读取

在页面或编辑屏幕上显示之前,此部分中的过滤器Filter将应用于从数据库读取的信息。

attachment_fields_to_edit

应用于编辑附件时要显示的表单域。在get_attachment_fields_to_edit函数中调用。Filter函数参数:表单字段数组,文章对象。

attachment_icon

应用于get_attachment_icon函数中附件的图标。Filter函数参数:图标文件作为HTML img标签,附件ID。

attachment_innerHTML

应用于要用于附件的标题(如果在get_attachment_innerHTML函数中没有图标)。Filter函数参数:内部HTML(默认为标题),附件ID。

author_edit_pre

在显示进行编辑之前应用于帖子作者。

body_class

应用于HTML元素的类。在get_body_class函数中调用。Filter函数参数:添加到第一个数组的类名数组和附加类名数组。

content_edit_pre
应用于在显示以进行编辑之前发布内容。

content_filtered_edit_pre
应用于发布在显示以进行编辑之前过滤的内容。

excerpt_edit_pre
适用于在显示编辑之前发布摘录。

date_edit_pre

在显示以供编辑之前应用于文章日期。

date_gmt_edit_pre

在显示以供编辑之前应用于文章日期。

get_attached_file
应用于get_attached_file函数检索的附加文件信息。Filter函数参数:文件信息、附件ID。

get_enclosed
get_enclosed函数应用于POST的附件列表。

get_pages
应用于get_pages函数返回的页面列表。Filter函数参数:页面列表(每个项目包含一个页面数据数组)、get_pages函数参数列表(告知请求了哪些页面)。

get_pung

通过get_pung函数应用于文章的ping URL列表。

get_the_archive_title

应用于get_the_archive_title函数中的档案标题。

get_the_excerpt

应用于get_the_excerpt函数中的文章摘录。

get_the_guid

在get_the_guid函数中应用于文章的GUID。

get_to_ping

通过get_to_ping函数应用于要ping文章的URL列表。

icon_dir
在几个函数中应用于模板的图像目录。基本上允许插件指定MIME类型的图标来自不同的位置。

icon_dir_uri
在几个函数中应用于模板的图像目录URI。基本上允许插件指定MIME类型的图标来自不同的位置。

image_size_names_choose

应用于媒体库中可选择的图像大小列表。通常用于使自定义图像大小可选。

mime_type_edit_pre
在显示进行编辑之前应用于文章 MIME类型。

modified_edit_pre
应用于显示编辑前的文章修改日期。

modified_gmt_edit_pre

应用于修改后的GMT日期,然后显示以供编辑。

no_texturize_shortcodes

适用于注册的短码。可用于将短代码从自动结构化函数中排除。

parent_edit_pre

在显示以供编辑之前应用于发布父ID。

password_edit_pre

在显示以供编辑之前应用于文章密码。

post_class

应用于帖子的最外层HTML元素的类。在get_post_class 函数中调用。过滤器函数参数:类名的数组、添加到第一个数组的附加类名的数组和文章 ID。

pre_kses

在KSES处理/清理之前应用于各种内容。这个钩子允许开发人员自定义内容中应该允许什么类型的scripts/tags,或者去掉什么类型的scripts/tags。

prepend_attachment

应用于要由prepend_attachment函数添加前缀的HTML。

protected_title_format

用于在文章受密码保护时更改或操作文章标题。

private_title_format

用于在帖子状态为私有时更改或操作文章标题。

sanitize_title

在去除HTML标记之后,由SANITIZE_TITLE函数应用于文章标题。

single_post_title

在wp_title和single_post_title函数用于创建博客页面标题时应用于文章标题。

status_edit_pre

在显示以进行编辑之前应用于文章状态。

the_content

在屏幕上显示之前,应用于从数据库检索的文章内容(也用于某些其他操作,如trackback)。

the_content_rss

在包含在RSS提要中之前应用于文章内容。(不赞成)。

the_content_feed

在包含在RSS提要中之前应用于文章内容。

the_editor_content

在将内容放入丰富编辑器窗口之前应用于发布内容。

the_excerpt

应用于在屏幕上打印之前从数据库检索到的文章摘录(如果没有摘录,则应用于文章内容)(也用于某些其他操作,如trackback)。

the_excerpt_rss

在包含在RSS提要中之前应用于文章摘录。

the_password_form

应用于受保护文章的密码表单。

the_tags

在屏幕上显示之前,应用于从数据库检索到的标签。

the_title

在屏幕上打印之前,应用于从数据库检索的文章标题(也用于某些其他操作,如trackback)。

the_title_rss

在包含在RSS提要中之前应用于文章标题(在第一次使用the_title过滤之后)。

title_edit_pre

在显示进行编辑之前应用于文章标题。

type_edit_pre

在显示进行编辑之前应用于文章文字。

wp_dropdown_pages

应用于wp_dropdown_page函数生成的WordPress页面的HTML下拉列表。

wp_list_pages

应用于wp_list_ages函数生成的HTML列表。

wp_list_pages_excludes

应用于wp_list_pages函数中排除的页面列表(页面ID数组)。

wp_get_attachment_metadata

应用于wp_get_attachment_metadata函数检索的附件元数据。过滤器函数参数:元数据,附件ID。

wp_get_attachment_thumb_file

应用于wp_get_attachment_thumb_file函数检索的附件缩略图文件。过滤器函数参数:缩略图文件,附件ID。

wp_get_attachment_thumb_url

应用于wp_get_attachment_thumb_URL函数检索的附件缩略图URL。过滤器函数参数:缩略图URL,附件ID。

wp_get_attachment_url

应用于wp_get_attachment_url函数检索的附件URL。过滤器函数参数:URL、附件ID。

wp_mime_type_icon

应用于wp_mime_type_icon函数计算的附件的MIME类型图标。过滤器函数参数:计算的图标URI、MIME类型、文章ID。

wp_title

在wp_title函数中发送到浏览器之前应用于博客页面标题。

原文

发表评论

电子邮件地址不会被公开。 必填项已用*标注