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

Timestamp:

05/28/2021 06:03:06 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for wp_list_filter() and wp_filter_object_list().

This should make the purpose and behavior of these functions more obvious without reading the code.

Props ribaricplusplus.
Fixes #52808.

File:

• trunk/src/wp-includes/class-wp-list-util.php (modified) (1 diff)

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

@@ -77 +77 @@
     /**
      * Filters the list, based on a set of key => value arguments.
+     *
+     * Retrieves the objects from the list that match the given arguments.
+     * Key represents property name, and value represents property value.
+     *
+     * If an object has more properties than those specified in arguments,
+     * that will not disqualify it. When using the 'AND' operator,
+     * any missing properties will disqualify it.
      *
      * @since 4.7.0