rest_parse_embed_param()
云策文档标注
概述
rest_parse_embed_param() 函数用于解析 REST API 中的 "_embed" 参数,将其转换为可嵌入资源的列表或布尔值 true。
关键要点
- 函数接受一个参数 $embed,可以是字符串或数组,表示原始的 "_embed" 参数值。
- 返回值:如果 $embed 为空、等于 'true' 或 '1',则返回 true 表示嵌入所有资源;否则,使用 wp_parse_list() 解析为数组,如果解析后为空数组也返回 true,否则返回解析后的关系列表。
- 该函数在 WordPress 5.4.0 版本中引入,常用于 REST API 请求处理中,如 rest_preload_api_request() 和 WP_REST_Server::serve_request()。
代码示例
function rest_parse_embed_param( $embed ) {
if ( ! $embed || 'true' === $embed || '1' === $embed ) {
return true;
}
$rels = wp_parse_list( $embed );
if ( ! $rels ) {
return true;
}
return $rels;
}
原文内容
Parses the “_embed” parameter into the list of resources to embed.
Parameters
$embedstring|arrayrequired-
Raw “_embed” parameter value.
Source
function rest_parse_embed_param( $embed ) {
if ( ! $embed || 'true' === $embed || '1' === $embed ) {
return true;
}
$rels = wp_parse_list( $embed );
if ( ! $rels ) {
return true;
}
return $rels;
}
Changelog
| Version | Description |
|---|---|
| 5.4.0 | Introduced. |