Changeset 55222

Timestamp:

02/04/2023 03:16:13 PM (22 months ago)

Author:

SergeyBiryukov

Message:

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.

File:

• trunk/src/wp-includes/category-template.php (modified) (1 diff)

trunk/src/wp-includes/category-template.php

@@ -1085 +1085 @@
  * @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 ) {