| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
WordPress List utility class
| File Size: | 279 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
WP_List_Util:: (7 methods):
__construct()
get_input()
get_output()
filter()
pluck()
sort()
sort_callback()
Class: WP_List_Util - X-Ref
List utility.| __construct( $input ) X-Ref |
| Constructor. Sets the input array. since: 4.7.0 param: array $input Array to perform operations on. |
| get_input() X-Ref |
| Returns the original input array. since: 4.7.0 return: array The input array. |
| get_output() X-Ref |
| Returns the output array. since: 4.7.0 return: array The output array. |
| filter( $args = array() X-Ref |
| 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 param: array $args Optional. An array of key => value arguments to match param: string $operator Optional. The logical operation to perform. 'AND' means return: array Array of found values. |
| pluck( $field, $index_key = null ) X-Ref |
| Plucks a certain field out of each object in the list. This has the same functionality and prototype of array_column() (PHP 5.5) but also supports objects. 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. return: array Array of found values. If `$index_key` is set, an array of found values with keys |
| sort( $orderby = array() X-Ref |
| Sorts the list, based on one or more orderby arguments. since: 4.7.0 param: string|array $orderby Optional. Either the field name to order by or an array param: string $order Optional. Either 'ASC' or 'DESC'. Only used if $orderby param: bool $preserve_keys Optional. Whether to preserve keys. Default false. return: array The sorted array. |
| sort_callback( $a, $b ) X-Ref |
| Callback to sort the list by specific fields. since: 4.7.0 param: object|array $a One object to compare. param: object|array $b The other object to compare. return: int 0 if both objects equal. -1 if second object should come first, 1 otherwise. |
| Generated: Mon Aug 2 01:00:04 2021 | Cross-referenced by PHPXref 0.7.1 |