函数文档

_usort_terms_by_name()

💡 云策文档标注

概述

_usort_terms_by_name() 是一个用于按名称排序分类(或任何术语对象)的回调函数,自 WordPress 4.7.0 起已弃用,建议改用 wp_list_sort()。

关键要点

  • 该函数作为 usort() 的回调使用,不应直接调用。
  • 参数 $a 和 $b 是必需的对象参数,用于比较术语名称。
  • 返回值为整数,基于 strcmp() 比较结果。
  • 自 WordPress 4.7.0 起被弃用,推荐使用 wp_list_sort() 替代。
  • 函数内部调用 _deprecated_function() 来标记弃用状态。

代码示例

function _usort_terms_by_name( $a, $b ) {
    _deprecated_function( __FUNCTION__, '4.7.0', 'wp_list_sort()' );
    return strcmp( $a->name, $b->name );
}

注意事项

  • 此函数已弃用,新代码中应避免使用,改用 wp_list_sort() 以确保兼容性和最佳实践。
  • 函数主要用于内部排序逻辑,开发者应通过 wp_list_sort() 或其他现代方法处理术语排序。

📄 原文内容

Sort categories by name.

Description

Used by usort() as a callback, should not be used directly. Can actually be used to sort any term object.

Parameters

$aobjectrequired
$bobjectrequired

Return

int

Source

function _usort_terms_by_name( $a, $b ) {
	_deprecated_function( __FUNCTION__, '4.7.0', 'wp_list_sort()' );

	return strcmp( $a->name, $b->name );
}

Changelog

Version Description
4.7.0 Deprecated. Use wp_list_sort()
2.3.0 Introduced.