Changeset 52066

Timestamp:

11/09/2021 01:09:11 AM (3 years ago)

Author:

hellofromTonya

Message:

General: Convert wp_list_filter() into a wrapper for wp_filter_object_list().

The code in wp_list_filter() was a duplicate of wp_filter_object_list(), minus the WP_List_Util::pluck() (used when $field is configured).

In testing the wrapper, discovered an edge case (and potential bug) in WP_List_Util::filter() where if the operator matches an empty array was returned without resetting the output property. Without that property being set correctly, WP_List_Util::get_output() was not correct. This commit also fixes this by resetting the property to an empty array.

Follow-up to [15686], [17427], [38928], [51044].

Props pbearne, sergeybiryukov, hellofromTonya.
Fixes #53988.

Location:

trunk/src/wp-includes

Files:

• class-wp-list-util.php (modified) (1 diff)
• functions.php (modified) (2 diffs)

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

@@ -103 +103 @@
 
         if ( ! in_array( $operator, array( 'AND', 'OR', 'NOT' ), true ) ) {
-            return array();
+            $this->output = array();
+            return $this->output;
         }
 

trunk/src/wp-includes/functions.php

@@ -5048 +5048 @@
  * @since 3.1.0
  * @since 4.7.0 Uses `WP_List_Util` class.
+ * @since 5.9.0 Converted into a wrapper for `wp_filter_object_list()`.
  *
  * @param array  $list     An array of objects to filter.
@@ -5059 +5060 @@
  */
 function wp_list_filter( $list, $args = array(), $operator = 'AND' ) {
-    if ( ! is_array( $list ) ) {
-        return array();
-    }
-
-    $util = new WP_List_Util( $list );
-
-    return $util->filter( $args, $operator );
+    return wp_filter_object_list( $list, $args, $operator );
 }