函数文档

wp_array_slice_assoc()

💡 云策文档标注

概述

wp_array_slice_assoc() 函数用于从关联数组中提取指定键的切片,仅返回存在的键值对。适用于 WordPress 开发中筛选数组数据的场景。

关键要点

  • 函数接受两个参数:$input_array(原始数组)和 $keys(键列表),均为必需。
  • 返回一个关联数组,包含 $input_array 中与 $keys 匹配且存在的键值对。
  • 函数内部通过循环检查键是否存在,避免未定义索引错误。
  • 在 WordPress 核心中广泛使用,如 WP_Script_Modules、WP_Term_Query 等类中。

代码示例

$options = get_option( 'my_theme' );

$needed_keys = array(
   'key_1',
   'key_4',
   'key_5',
);
$filtered_keys = wp_array_slice_assoc( $options, $needed_keys );

📄 原文内容

Extracts a slice of an array, given a list of keys.

Parameters

$input_arrayarrayrequired
The original array.
$keysarrayrequired
The list of keys.

Return

array The array slice.

Source

function wp_array_slice_assoc( $input_array, $keys ) {
	$slice = array();

	foreach ( $keys as $key ) {
		if ( isset( $input_array[ $key ] ) ) {
			$slice[ $key ] = $input_array[ $key ];
		}
	}

	return $slice;
}

Changelog

Version Description
3.1.0 Introduced.

User Contributed Notes