“Function Reference/apply filters”的版本间的差异

来自WordPress中文文档
跳转至: 导航搜索
Return
(1个修订)
(没有差异)

2009年3月14日 (六) 09:23的版本

Description

Call the functions added to a filter hook. See the Plugin API for a list of filter hooks.

The callback functions attached to filter hook tt$tag/tt are invoked by calling this function. This function can be used to create a new filter hook by simply calling this function with the name of the new hook specified using the tt$tag/tt parameter.

Usage

%%% ?php apply_filters($tag, $value); ? %%%

Parameters

tt$tag/tt
(string) (required) The name of the filter hook.
Default: Nonenoinclude

div class=template-description style=padding: 0 1.5em; border: 1px solid #eeeeee; background-color: #f9f9f9

Notes

This template is for standardizing how parameters look in the Function Reference and in Template Tags. Here is an example of this template being called: prenowiki检查到模板循环:模板:Parameter/nowiki/pre 检查到模板循环:模板:Parameter

The usage of this template is below: prenowiki检查到模板循环:模板:Parameter/nowiki/pre Let's take a closer look at the parameters..

name
The name of the parameter.
datatype
The datatype that should be given for this parameter when called.
  • string
  • integer
  • boolean
  • mixed
description
A short description of the parameter.
importance
Set this parameter to optional if the parameter is optional. Otherwise, do not declare this parameter—it defaults to required.
  • required
  • optional
default
If this parameter is optional, ttdefault/tt is the value that will be used if the parameter is not declared.

wordpress.org.cn /div /noinclude

tt$value/tt
(mixed) (required) The value which the filters hooked to tt$tag/tt may modify.
Default: Nonenoinclude

div class=template-description style=padding: 0 1.5em; border: 1px solid #eeeeee; background-color: #f9f9f9

Notes

This template is for standardizing how parameters look in the Function Reference and in Template Tags. Here is an example of this template being called: prenowiki检查到模板循环:模板:Parameter/nowiki/pre 检查到模板循环:模板:Parameter

The usage of this template is below: prenowiki检查到模板循环:模板:Parameter/nowiki/pre Let's take a closer look at the parameters..

name
The name of the parameter.
datatype
The datatype that should be given for this parameter when called.
  • string
  • integer
  • boolean
  • mixed
description
A short description of the parameter.
importance
Set this parameter to optional if the parameter is optional. Otherwise, do not declare this parameter—it defaults to required.
  • required
  • optional
default
If this parameter is optional, ttdefault/tt is the value that will be used if the parameter is not declared.

wordpress.org.cn /div /noinclude

Return

(mixed) The result of tt$value/tt after all hooked functions are applied to it.

Note: The type of return should be the same as the type of $value: a string or an array, for example.