Docs: Use consistent format for the @return tags in _wp_object_name_sort_cb() and _wp_object_count_sort_cb().

Both functions are used as a callback for `uasort()`.

Follow-up to [36013], [55214].

See #57358, #56792.

git-svn-id: https://develop.svn.wordpress.org/trunk@55222 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2023-02-04 15:16:13 +00:00
parent d90afeeb69
commit 1226afc5a4

View File

@@ -1084,7 +1084,8 @@ function _wp_object_name_sort_cb( $a, $b ) {
*
* @param object $a The first object to compare.
* @param object $b The second object to compare.
* @return int The count value for `$a` minus the count value for `$b` (less than, equal to, or greater than zero).
* @return int Negative number if `$a->count` is less than `$b->count`, zero if they are equal,
* or greater than zero if `$a->count` is greater than `$b->count`.
*/
function _wp_object_count_sort_cb( $a, $b ) {
return ( $a->count - $b->count );