函数文档

_wp_register_meta_args_whitelist()

💡 云策文档标注

概述

_wp_register_meta_args_whitelist() 是一个已弃用的 WordPress 函数,用于基于允许列表过滤 register_meta() 的参数。自 5.5.0 版本起,建议使用 _wp_register_meta_args_allowed_list() 替代。

关键要点

  • 此函数已弃用,自 WordPress 5.5.0 起应使用 _wp_register_meta_args_allowed_list()。
  • 它过滤 register_meta() 的参数,确保只使用允许列表中的参数,以应对参数随时间变化的情况。
  • 函数接受两个参数:$args(register_meta() 的参数)和 $default_args(默认参数),并返回过滤后的参数数组。

代码示例

function _wp_register_meta_args_whitelist( $args, $default_args ) {
    _deprecated_function( __FUNCTION__, '5.5.0', '_wp_register_meta_args_allowed_list()' );

    return _wp_register_meta_args_allowed_list( $args, $default_args );
}

注意事项

  • 使用此函数会触发 _deprecated_function() 警告,提示开发者更新代码。
  • 建议编写更具包容性的代码,避免使用“whitelist”等术语。

📄 原文内容

Filters out register_meta() args based on an allowed list.

Description

register_meta() args may change over time, so requiring the allowed list to be explicitly turned off is a warranty seal of sorts.

Parameters

$argsarrayrequired
Arguments from register_meta().
$default_argsarrayrequired
Default arguments for register_meta().

Return

array Filtered arguments.

Source

function _wp_register_meta_args_whitelist( $args, $default_args ) {
	_deprecated_function( __FUNCTION__, '5.5.0', '_wp_register_meta_args_allowed_list()' );

	return _wp_register_meta_args_allowed_list( $args, $default_args );
}

Changelog

Version Description
5.5.0 Deprecated. Use _wp_register_meta_args_allowed_list() instead.
Please consider writing more inclusive code.
4.6.0 Introduced.