云策 WordPress 开发者社区

函数文档

rest_is_array()

查看官方原文 ↗
💡 云策文档标注

概述

rest_is_array() 函数用于判断给定值是否为类数组结构，支持将标量值转换为数组后检查。它是 WordPress REST API 中的辅助函数，常用于数据验证和处理。

关键要点

  • 函数接受一个参数 $maybe_array，用于评估是否为类数组
  • 如果 $maybe_array 是标量值，会先通过 wp_parse_list() 转换为数组
  • 最终通过 wp_is_numeric_array() 判断是否为数字索引数组
  • 在 WordPress 5.5.0 版本中引入

代码示例

function rest_is_array( $maybe_array ) {
    if ( is_scalar( $maybe_array ) ) {
        $maybe_array = wp_parse_list( $maybe_array );
    }

    return wp_is_numeric_array( $maybe_array );
}

注意事项

  • 函数主要用于 REST API 上下文，如 WP_REST_Posts_Controller::prepare_tax_query() 和 rest_validate_array_value_from_schema()
  • 依赖 wp_parse_list() 和 wp_is_numeric_array() 函数，确保这些函数在环境中可用
📄 原文内容

Determines if a given value is array-like.

Parameters

$maybe_arraymixedrequired
The value being evaluated.

Return

bool

Source

function rest_is_array( $maybe_array ) {
	if ( is_scalar( $maybe_array ) ) {
		$maybe_array = wp_parse_list( $maybe_array );
	}

	return wp_is_numeric_array( $maybe_array );
}

View all references View on Trac View on GitHub

Uses Description
wp_parse_list()wp-includes/functions.php

Converts a comma- or space-separated list of scalar values to an array.
wp_is_numeric_array()wp-includes/functions.php

Determines if the variable is a numeric-indexed array.
Used by Description
WP_REST_Posts_Controller::prepare_tax_query()wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Prepares the ‘tax_query’ for a collection of posts.
rest_validate_array_value_from_schema()wp-includes/rest-api.php

Validates an array value based on a schema.
rest_filter_response_by_context()wp-includes/rest-api.php

Filters the response to remove any fields not available in the given context.

Changelog

Version Description
5.5.0 Introduced.