函数文档

_usort_terms_by_ID()

💡 云策文档标注

概述

_usort_terms_by_ID() 是一个用于按 ID 排序分类(或任何术语对象)的回调函数,自 WordPress 4.7.0 起已弃用,建议使用 wp_list_sort() 替代。

关键要点

  • 函数用途:作为 usort() 的回调,按 term_id 比较两个术语对象,返回排序顺序(1、-1 或 0)。
  • 弃用状态:自 WordPress 4.7.0 起弃用,推荐使用 wp_list_sort() 函数。
  • 参数要求:接受两个必需参数 $a 和 $b,均为对象类型。
  • 返回值:整数,表示排序结果。

代码示例

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

    if ( $a->term_id > $b->term_id )
        return 1;
    elseif ( $a->term_id < $b->term_id )
        return -1;
    else
        return 0;
}

注意事项

  • 此函数不应直接调用,仅作为 usort() 的回调使用。
  • 弃用后,继续使用可能触发 _deprecated_function() 警告。
  • 相关函数:_deprecated_function() 用于标记弃用。

📄 原文内容

Sort categories by ID.

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_ID( $a, $b ) {
	_deprecated_function( __FUNCTION__, '4.7.0', 'wp_list_sort()' );

	if ( $a->term_id > $b->term_id )
		return 1;
	elseif ( $a->term_id < $b->term_id )
		return -1;
	else
		return 0;
}

Changelog

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