Changeset 52422 for trunk/src/wp-includes/class-wp-list-util.php

Timestamp:

12/29/2021 05:26:26 PM (3 years ago)

Author:

johnbillion

Message:

Docs: Miscellaneous inline documentation improvements.

See #53399

File:

• trunk/src/wp-includes/class-wp-list-util.php (modified) (5 diffs)

trunk/src/wp-includes/class-wp-list-util.php

@@ -10 +10 @@
  * List utility.
  *
- * Utility class to handle operations on an array of objects.
+ * Utility class to handle operations on an array of objects or arrays.
  *
  * @since 4.7.0
@@ -141 +141 @@
 
     /**
-     * Plucks a certain field out of each object in the list.
+     * Plucks a certain field out of each element in the input array.
      *
      * This has the same functionality and prototype of
@@ -148 +148 @@
      * @since 4.7.0
      *
-     * @param int|string $field     Field from the object to place instead of the entire object
-     * @param int|string $index_key Optional. Field from the object to use as keys for the new array.
+     * @param int|string $field     Field to fetch from the object or array.
+     * @param int|string $index_key Optional. Field from the element to use as keys for the new array.
      *                              Default null.
      * @return array Array of found values. If `$index_key` is set, an array of found values with keys
@@ -202 +202 @@
 
     /**
-     * Sorts the list, based on one or more orderby arguments.
+     * Sorts the input array based on one or more orderby arguments.
      *
      * @since 4.7.0
@@ -240 +240 @@
 
     /**
-     * Callback to sort the list by specific fields.
+     * Callback to sort an array by specific fields.
      *
      * @since 4.7.0