从 WordPress 5.5 开始,register_meta() 函数(包括 register_post_meta())支持注册元数据默认值。在此之前,只能像这样注册REST API模式的默认值:
register_meta(
'post',
'greeting',
array(
'single' => true,
'type' => 'string',
'show_in_rest' => array(
'schema' => array(
'type' => 'string',
'default' => 'hello',
),
),
)
);
但是,这仅适用于从REST API内进行的调用 - 使用get_post_meta()将无法获取默认值。
WordPress 5.5 开始,可以传递一个默认值,该值将应用于任何元函数的所有调用,如下所示:
register_meta(
'post',
'greeting',
array(
'single' => true,
'type' => 'string',
'default' => 'hello',
'show_in_rest' => array(
'schema' => array(
'type' => 'string',
),
),
)
);
此次对register_meta()的改进,很像另一个函数register_setting(),自WordPress 4.7起,可以在register_setting()中注册选项的默认值。
默认值还可以与对象子类型(在WordPress 4.9.8中引入)配对,以限制默认值的范围。例如,如果插件注册的自定义文章类型为product。开发人员可以注册仅适用于product这个文章类型的默认值。如下所示:
register_post_meta(
'product',
'price',
array(
'single' => true,
'type' => 'string',
'default' => '0.00',
)
);
值得注意的是,将默认值注册到这样的自定义文章类型可能会带来一些性能开销。要确定当前文章ID是哪种文章类型,它必须加载该对象。有关更多详细信息,请参见get_object_subtype。在大多数情况下,meta和主对象是同时加载的(例如使用WP_Query时),但是如果您的代码除了加载meta数据以外还执行其他操作,那么它现在也可以加载主对象类型。
非单一元数据
也可以注册非单一(Non-Single)的默认值,如下所示:
register_post_meta(
'product',
'price',
array(
'single' => false,
'type' => 'string',
'default' => '0.00',
)
);
请求多个值时,如下所示:
$result = get_post_meta( 123, 'price', false );
上面的代码将返回一个以0.00作为第一个值的数字数组。
验证方式
注册默认元值时,数据必须与提供的类型匹配。以下示例将触发_doing_it_wrong通知提示hello不是整数(integer)。
register_meta(
'post',
'greeting',
array(
'single' => true,
'type' => 'integer',
'default' => 'hello',
)
);
新过滤器
如果您希望使用默认的元值进行一些真正的自定义,现在有一个过滤器:
$value = apply_filters( "default_{$meta_type}_metadata", $value, $object_id, $meta_key, $single, $meta_type );
这是一个动态过滤器,要求您添加元类型。这是一个用法示例:
function add_my_meta_value( $value, $object_id, $meta_key, $single ){
if( 'price' === $meta_key ) {
if ( ! $single ) {
$value = array( '0.99' );
} else {
$value = '0.99';
}
}
}
add_filter( 'default_post_metadata', 'add_my_meta_value', 10, 4 );
新函数
为了使此功能成为可能,WordPress 核心添加了两个新函数:
get_metadata_raw()
get_metadata_default()
现在,get_metadata()函数调用get_metadata_raw(),如果该值为null,则调用get_metadata_default()。因此,调用get_metadata()不再获取原始值,这就是现在使用get_metadata_raw()的目的。
发表评论