云策 WordPress 开发者社区

函数文档

wp_parse_id_list()

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

概述

wp_parse_id_list() 函数用于清理和标准化 ID 列表，支持数组、逗号或空格分隔的字符串输入，返回一个唯一的整数数组。

关键要点

  • 参数 $input_list 可以是数组或字符串，必需，表示 ID 列表。
  • 返回值是 int[] 类型，即经过清理和去重的整数数组。
  • 内部实现依赖于 wp_parse_list() 函数进行初步转换，然后使用 absint() 和 array_unique() 确保 ID 为正整数且唯一。

代码示例

function wp_parse_id_list( $input_list ) {
    $input_list = wp_parse_list( $input_list );
    return array_unique( array_map( 'absint', $input_list ) );
}

注意事项

  • 该函数自 WordPress 3.0.0 版本引入，在 5.1.0 版本重构以使用 wp_parse_list()。
  • 广泛用于多个核心类和方法中，如 WP_Query 相关类、隐私请求处理、小部件内容检查等。
📄 原文内容

Cleans up an array, comma- or space-separated list of IDs.

Parameters

$input_listarray|stringrequired
List of IDs.

Return

int[] Sanitized array of IDs.

Source

function wp_parse_id_list( $input_list ) {
	$input_list = wp_parse_list( $input_list );

	return array_unique( array_map( 'absint', $input_list ) );
}

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.
Used by Description
WP_Privacy_Requests_Table::process_bulk_action()wp-admin/includes/class-wp-privacy-requests-table.php

Process bulk actions.
WP_Widget_Media_Gallery::has_content()wp-includes/widgets/class-wp-widget-media-gallery.php

Whether the widget has content to show.
WP_Customize_Nav_Menus::sanitize_nav_menus_created_posts()wp-includes/class-wp-customize-nav-menus.php

Sanitizes post IDs for posts created for nav menu items to be published.
WP_Term_Query::get_terms()wp-includes/class-wp-term-query.php

Retrieves the query results.
WP_Term_Query::parse_orderby()wp-includes/class-wp-term-query.php

Parse and sanitize ‘orderby’ keys passed to the term query.
WP_Network_Query::get_network_ids()wp-includes/class-wp-network-query.php

Used internally to get a list of network IDs matching the query vars.
WP_Site_Query::get_site_ids()wp-includes/class-wp-site-query.php

Used internally to get a list of site IDs matching the query vars.
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_User_Query::parse_orderby()wp-includes/class-wp-user-query.php

Parses and sanitizes ‘orderby’ keys passed to the user query.
wp_list_categories()wp-includes/category-template.php

Displays or retrieves the HTML list of categories.
WP_Tax_Query::clean_query()wp-includes/class-wp-tax-query.php

Validates a single query.
WP_Tax_Query::transform_query()wp-includes/class-wp-tax-query.php

Transforms a single query, from one field to another.
WP_User_Query::prepare_query()wp-includes/class-wp-user-query.php

Prepares the query variables.
get_pages()wp-includes/post.php

Retrieves an array of pages (or hierarchical post type items).
get_posts()wp-includes/post.php

Retrieves an array of the latest posts, or posts matching the given criteria.
get_bookmarks()wp-includes/bookmark.php

Retrieves the list of bookmarks.

Show 11 moreShow less

Changelog

Version Description
5.1.0 Refactored to use wp_parse_list() .
3.0.0 Introduced.