文章来源于网络收集而来，版权归原创者所有，如有侵权请及时联系！

add_filter()

发布于 2017-07-23 22:31:34 字数 12504 浏览 1859 评论 0 收藏 0

add_filter( string $tag,  callable $function_to_add,  int $priority = 10,  int $accepted_args = 1 )

将函数连接到特定过滤器动作。

description

过滤器是WordPress发布的一种 hook ，在不同类别的文本被添加到书库据或发送到浏览器窗口前对这些文本进行修改。插件可用过滤器API规定在修改特定类型的文本时，执行一个还是多个PHP函数。

WordPress 提供了过滤器钩子，允许插件在运行时修改各种类型的内部数据。

插件可以通过将回调绑定到筛选器钩子来修改数据。当稍后应用筛选器时，每个绑定回调按优先级顺序运行，并有机会通过返回一个新值来修改一个值。

下面的示例演示回调函数如何绑定到筛选器钩子。

变量 $example 返回给回调函数，可能是修改后的数据：

function example_callback( $example ) {
    // Maybe modify $example in some way.
    return $example;
}
add_filter( 'example_filter', 'example_callback' );

绑定回调函数可以接受从没有到作为参数传递参数的总数，在相应的 apply_filters() 调用。

换句话说，如果一个 apply_filters() 有四个可选参数，它可以接受任何个数的参数，参数可以设置为一个或者四个。重要的是，$accepted_args 的值必须反映参数绑定回调 actuallyopted 接受参数的个数。如果没有设置被认为与接受1参数相同的回调参数。例如:

// Filter call.
$value = apply_filters( 'hook', $value, $arg2, $arg3 );

// Accepting zero/one arguments.
function example_callback() {
    ...
    return 'some value';
}
add_filter( 'hook', 'example_callback' ); // Where $priority is default 10, $accepted_args is default 1.

// Accepting two arguments (three possible).
function example_callback( $value, $arg2 ) {
    ...
    return $maybe_modified_value;
}
add_filter( 'hook', 'example_callback', 10, 2 ); // Where $priority is 10, $accepted_args is 2.

注意：无论回调函数是否有效，函数将返回true。由你来负责。这样做是为了优化目的，所以一切都尽可能快。

参数

$tag: (string)
(Required)
连接到 $function_to_add 的过滤器名称
$function_to_add: (callable)
(Required)
应用过滤器时被调用函数的名称。
$priority: (int)
(Optional)
用于规定函数被执行的顺序，函数与特定动作关联。较小的数字匹配较早的执行，同等优先级的函数按加入action的顺序被执行。默认：10。
$accepted_args: (int)
(Optional)
函数所接受参数的数量。在 WordPress 1.5.1 及之后版本中，连接的函数可吸收其它在调用 do_action() 或 apply_filters() 时设置的参数。默认：1。

返回值

(true)

源代码

File: wp-includes/plugin.php

function add_filter( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) {
	global $wp_filter;
	if ( ! isset( $wp_filter[ $tag ] ) ) {
		$wp_filter[ $tag ] = new WP_Hook();
	}
	$wp_filter[ $tag ]->add_filter( $tag, $function_to_add, $priority, $accepted_args );
	return true;
}

更新日志

Version	description
0.71	Introduced.

More Information

Hooked的功能可以采取额外的参数设置，当匹配 do_action() 或 apply_filters() 调用运行。例如，在 comment_id_not_found 行动将通过评论 ID 每个回调。
虽然你可以通过 $accepted_args 设置参数的数量，你只能操纵 $value 。其他参数仅用于提供上下文，它们的值不能通过筛选器函数更改。
还可以将类方法传递为回调函数。

静态类方法：

add_filter( 'media_upload_newtab', array( 'My_Class', 'media_upload_callback' ) );

实例方法：

add_filter( 'media_upload_newtab', array( $this, 'media_upload_callback' ) );

还可以将匿名函数传递为回调函数。例如：

add_filter( 'the_title', function( $title ) { return '<strong>' . $title . '</strong>'; } );

使用方法

例如：让我们添加 WordPress 默认主题 twentyseventeen 额外的部分的头版。默认情况下，twentyseventeen 主题有4节的首页。这个例子将使他们有6个。

add_filter( 'twentyseventeen_front_page_sections', 'prefix_custom_front_page_sections' );
function prefix_custom_front_page_sections( $num_sections ){
	return 6;
}

示例：让显示自定义长度的文章摘录。

if( ! function_exists( 'prefix_custom_excerpt_length' ) ){
	function prefix_custom_excerpt_length( $length )
	{
		return 40;
	}
}
add_filter( 'excerpt_length', 'prefix_custom_excerpt_length', 999 );

默认情况下，WordPress 的摘要显示57字符。使用上面的代码你可以设置自定义的长度。

Example

过滤器 img_caption_shortcode 将会在 media.php 页面调用：

// Allow plugins/themes to override the default caption template.
$output = apply_filters( 'img_caption_shortcode', '', $attr, $content );
if ( $output != '' )
	return $output;

将用三个参数调用目标筛选器函数：

'' <= 这通常是过滤器将被修改的值。
$attr
$content

为了过滤功能，实际收到全部的参数列表调用 add_filter() 必须修改指定的参数列表上有3个参数。

add_filter('img_caption_shortcode', 'my_img_caption_shortcode_filter',10,3);

/**
 * Filter to replace the  shortcode text with HTML5 compliant code
 * @return text HTML content describing embedded figure
 **/
function my_img_caption_shortcode_filter($val, $attr, $content = null){
	extract( shortcode_atts( array(
		'id'	=> '',
		'align'	=> '',
		'width'	=> '',
		'caption' => ''
	), $attr ) );
	
	if ( 1 > (int) $width || empty($caption) )
		return $val;

	$capid = '';
	if ( $id ) {
		$id = esc_attr( $id );
		$capid = 'id="figcaption_' . $id . '" ';
		$id = 'id="' . $id . '" aria-labelledby="figcaption_' . $id . '" ';
	}

	return '<figure ' . $id . 'class="wp-caption ' . esc_attr($align) . '" style="width: '
	. (10 + (int) $width) . 'px">' . do_shortcode( $content ) . '<figcaption ' . $capid 
	. 'class="wp-caption-text">' . $caption . '</figcaption></figure>';
}

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

列表为空，暂无数据

add_filter()

description

参数

返回值

源代码

更新日志

More Information

相关函数

Used By

使用方法

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

add_filter()

description

参数

返回值

源代码

更新日志

More Information

相关函数

Used By

使用方法

如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。