apply_filters_deprecated

函数
apply_filters_deprecated ( $hook_name, $args, $version, $replacement = '', $message = '' )
参数
  • (string) $hook_name The name of the filter hook.
    Required:
  • (array) $args Array of additional function arguments to be passed to apply_filters().
    Required:
  • (string) $version The version of WordPress that deprecated the hook.
    Required:
  • (string) $replacement Optional. The hook that should have been used. Default empty.
    Required:
    Default: (empty)
  • (string) $message Optional. A message regarding the change. Default empty.
    Required:
    Default: (empty)
相关
  • _deprecated_hook()
定义位置
相关方法
apply_filters_ref_arrayapply_filtersdo_action_deprecatedwp_filter_post_kseswp_apply_colors_support
引入
4.6.0
弃用
-

apply_filters_deprecated: 这个函数与apply_filters相似,但它是用来应用已弃用的过滤器。它需要三个参数:第一个是要应用的过滤器的名称,第二个是要过滤的值,第三个是当使用过时的过滤器时显示给开发者的信息。

执行附属于已弃用的过滤器钩子的函数。

当一个过滤器钩子被弃用时,apply_filters()调用被替换为apply_filters_deprecated(),这将触发一个弃用通知,然后触发原始过滤器钩子。

注意:传递给原始apply_filters()调用的值和额外的参数必须作为一个数组在这里传递给`$args`。比如说:

// Old filter.
return apply_filters( ‘wpdocs_filter’, $value, $extra_arg );

// Deprecated.
return apply_filters_deprecated( ‘wpdocs_filter’, array( $value, $extra_arg ), ‘4.9.0’, ‘wpdocs_new_filter’ );

function apply_filters_deprecated( $hook_name, $args, $version, $replacement = '', $message = '' ) {
	if ( ! has_filter( $hook_name ) ) {
		return $args[0];
	}

	_deprecated_hook( $hook_name, $version, $replacement, $message );

	return apply_filters_ref_array( $hook_name, $args );
}

常见问题

FAQs
查看更多 >