云策 WordPress 开发者社区

函数文档

wp_parse_list()

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

概述

wp_parse_list() 函数用于将逗号或空格分隔的标量值列表转换为数组。它接受数组或字符串输入，并返回一个经过验证的标量值数组。

关键要点

  • 参数 $input_list 可以是数组或字符串，为必需参数，表示要转换的值列表。
  • 返回值是一个数组，包含转换后的标量值。
  • 如果输入是字符串，函数使用正则表达式按逗号或空格分割；如果输入是数组，则过滤掉非标量值。
  • 该函数自 WordPress 5.1.0 版本引入。

代码示例

$string = 'apple, banana, cherry';
$items = wp_parse_list( $string );
print_r( $items );
📄 原文内容

Converts a comma- or space-separated list of scalar values to an array.

Parameters

$input_listarray|stringrequired
List of values.

Return

array Array of values.

Source

function wp_parse_list( $input_list ) {
	if ( ! is_array( $input_list ) ) {
		return preg_split( '/[s,]+/', $input_list, -1, PREG_SPLIT_NO_EMPTY );
	}

	// Validate all entries of the list are scalar.
	$input_list = array_filter( $input_list, 'is_scalar' );

	return $input_list;
}

View all references View on Trac View on GitHub

Used by Description
WP_Theme::get_block_patterns()wp-includes/class-wp-theme.php

Gets block pattern data for a specified theme.
WP_REST_Pattern_Directory_Controller::get_transient_key()wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php

Include a hash of the query args, so that different requests are stored in separate caches.
WP_REST_Menu_Items_Controller::get_item_schema()wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php

Retrieves the nav menu item’s schema, conforming to JSON Schema.
rest_sanitize_array()wp-includes/rest-api.php

Converts an array-like value to an array.
rest_is_array()wp-includes/rest-api.php

Determines if a given value is array-like.
rest_parse_embed_param()wp-includes/rest-api.php

Parses the “_embed” parameter into the list of resources to embed.
WP_REST_Controller::get_fields_for_response()wp-includes/rest-api/endpoints/class-wp-rest-controller.php

Gets an array of fields to be included on the response.
rest_filter_response_fields()wp-includes/rest-api.php

Filters the REST API response to include only an allow-listed set of response object fields.
wp_parse_slug_list()wp-includes/functions.php

Cleans up an array, comma- or space-separated list of slugs.
WP_REST_Server::get_index()wp-includes/rest-api/class-wp-rest-server.php

Retrieves the site index.
WP_Comment_Query::get_comment_ids()wp-includes/class-wp-comment-query.php

Used internally to get a list of comment IDs matching the query vars.
wp_parse_id_list()wp-includes/functions.php

Cleans up an array, comma- or space-separated list of IDs.
get_pages()wp-includes/post.php

Retrieves an array of pages (or hierarchical post type items).

Show 8 moreShow less

Changelog

Version Description
5.1.0 Introduced.

User Contributed Notes