函数文档

wp_recursive_ksort()

💡 云策文档标注

概述

wp_recursive_ksort() 是一个 WordPress 核心函数,用于递归地对数组的键进行字母顺序排序。它通过引用传递数组,不返回值,模拟 ksort() 的行为。

关键要点

  • 函数递归排序数组键,适用于嵌套数组结构。
  • 数组通过引用传递,直接修改原数组,不返回新数组。
  • 基于 ksort() 实现,确保键按字母顺序排列。
  • 在 WordPress 6.0.0 版本中引入。

代码示例

function wp_recursive_ksort( &$input_array ) {
    foreach ( $input_array as &$value ) {
        if ( is_array( $value ) ) {
            wp_recursive_ksort( $value );
        }
    }

    ksort( $input_array );
}

注意事项

  • 函数仅排序键,不处理值的内容。
  • 适用于需要保持数组结构一致性的场景,如主题 JSON 数据处理。

📄 原文内容

Sorts the keys of an array alphabetically.

Description

The array is passed by reference so it doesn’t get returned which mimics the behavior of ksort().

Parameters

$input_arrayarrayrequired
The array to sort, passed by reference.

Source

function wp_recursive_ksort( &$input_array ) {
	foreach ( $input_array as &$value ) {
		if ( is_array( $value ) ) {
			wp_recursive_ksort( $value );
		}
	}

	ksort( $input_array );
}

Changelog

Version Description
6.0.0 Introduced.