Changeset 36013 for trunk/src/wp-includes/category-template.php

Timestamp:

12/18/2015 11:37:58 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Add missing parameter and return descriptions to the DocBlocks for _wp_object_name_sort_cb() and _wp_object_count_sort_cb(), both uasort() callbacks.

See #32246.

File:

• trunk/src/wp-includes/category-template.php (modified) (2 diffs)

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

@@ -948 +948 @@
 
 /**
- * Callback for comparing objects based on name
+ * Serves as a callback for comparing objects based on name.
+ *
+ * Used with `uasort()`.
  *
  * @since 3.1.0
  * @access private
- * @return int
+ *
+ * @param object $a The first object to compare.
+ * @param object $b The second object to compare.
+ * @return int Negative number if `$a->name` is less than `$b->name`, zero if they are equal,
+ *             or greater than zero if `$a->name` is greater than `$b->name`.
  */
 function _wp_object_name_sort_cb( $a, $b ) {
@@ -959 +965 @@
 
 /**
- * Callback for comparing objects based on count
+ * Serves as a callback for comparing objects based on count.
+ *
+ * Used with `uasort()`.
  *
  * @since 3.1.0
  * @access private
- * @return bool
+ *
+ * @param object $a The first object to compare.
+ * @param object $b The second object to compare.
+ * @return bool Whether the count value for `$a` is greater than the count value for `$b`.
  */
 function _wp_object_count_sort_cb( $a, $b ) {