General: Introduce a wp_list_sort() helper function, v2.

In addition to `wp_list_filter()` for filtering a list of objects, and `wp_list_pluck()` for plucking a certain field out of each object in a list, this new function can be used for sorting a list of objects by specific fields. These functions are now all contained within the new `WP_List_Util()` class and `wp_list_sort()` is used in various parts of core for sorting lists.

This was previously committed in [38859] but got reverted in [38862] and [38863]. To fix the previous issues, `wp_list_sort()` supports now an additional argument to preserve array keys via `uasort()`.

Props flixos90, DrewAPicture, jorbin.
Fixes #37128.

git-svn-id: https://develop.svn.wordpress.org/trunk@38928 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Dominik Schilling (ocean90)
2016-10-25 21:25:25 +00:00
parent 0c14ff0574
commit ad25902a65
12 changed files with 957 additions and 150 deletions

View File

@@ -1862,6 +1862,73 @@ class Tests_WP_Customize_Manager extends WP_UnitTestCase {
function filter_customize_previewable_devices( $devices ) {
return $this->filtered_device_list();
}
/**
* @ticket 37128
*/
function test_prepare_controls_wp_list_sort_controls() {
wp_set_current_user( self::$admin_user_id );
$controls = array( 'foo' => 2, 'bar' => 4, 'foobar' => 3, 'key' => 1 );
$controls_sorted = array( 'key', 'foo', 'foobar', 'bar' );
$this->manager->add_section( 'foosection', array() );
foreach ( $controls as $control_id => $priority ) {
$this->manager->add_setting( $control_id );
$this->manager->add_control( $control_id, array(
'priority' => $priority,
'section' => 'foosection',
) );
}
$this->manager->prepare_controls();
$result = $this->manager->controls();
$this->assertEquals( $controls_sorted, array_keys( $result ) );
}
/**
* @ticket 37128
*/
function test_prepare_controls_wp_list_sort_sections() {
wp_set_current_user( self::$admin_user_id );
$sections = array( 'foo' => 2, 'bar' => 4, 'foobar' => 3, 'key' => 1 );
$sections_sorted = array( 'key', 'foo', 'foobar', 'bar' );
foreach ( $sections as $section_id => $priority ) {
$this->manager->add_section( $section_id, array(
'priority' => $priority,
) );
}
$this->manager->prepare_controls();
$result = $this->manager->sections();
$this->assertEquals( $sections_sorted, array_keys( $result ) );
}
/**
* @ticket 37128
*/
function test_prepare_controls_wp_list_sort_panels() {
wp_set_current_user( self::$admin_user_id );
$panels = array( 'foo' => 2, 'bar' => 4, 'foobar' => 3, 'key' => 1 );
$panels_sorted = array( 'key', 'foo', 'foobar', 'bar' );
foreach ( $panels as $panel_id => $priority ) {
$this->manager->add_panel( $panel_id, array(
'priority' => $priority,
) );
}
$this->manager->prepare_controls();
$result = $this->manager->panels();
$this->assertEquals( $panels_sorted, array_keys( $result ) );
}
}
require_once ABSPATH . WPINC . '/class-wp-customize-setting.php';

View File

@@ -0,0 +1,459 @@
<?php
/**
* @group functions.php
*/
class Tests_WP_List_Util extends WP_UnitTestCase {
public function data_test_wp_list_pluck() {
return array(
'arrays' => array(
array(
array( 'foo' => 'bar', 'bar' => 'baz', 'abc' => 'xyz' ),
array( 'foo' => 'foo', '123' => '456', 'lorem' => 'ipsum' ),
array( 'foo' => 'baz' ),
),
'foo',
null,
array( 'bar', 'foo', 'baz' ),
),
'arrays with index key' => array(
array(
array( 'foo' => 'bar', 'bar' => 'baz', 'abc' => 'xyz', 'key' => 'foo' ),
array( 'foo' => 'foo', '123' => '456', 'lorem' => 'ipsum', 'key' => 'bar' ),
array( 'foo' => 'baz', 'key' => 'value' ),
),
'foo',
'key',
array( 'foo' => 'bar', 'bar' => 'foo', 'value' => 'baz' ),
),
'arrays with index key missing' => array(
array(
array( 'foo' => 'bar', 'bar' => 'baz', 'abc' => 'xyz' ),
array( 'foo' => 'foo', '123' => '456', 'lorem' => 'ipsum', 'key' => 'bar' ),
array( 'foo' => 'baz', 'key' => 'value' ),
),
'foo',
'key',
array( 'bar' => 'foo', 'value' => 'baz', 'bar' ),
),
'objects' => array(
array(
(object) array( 'foo' => 'bar', 'bar' => 'baz', 'abc' => 'xyz' ),
(object) array( 'foo' => 'foo', '123' => '456', 'lorem' => 'ipsum' ),
(object) array( 'foo' => 'baz' ),
),
'foo',
null,
array( 'bar', 'foo', 'baz' ),
),
'objects with index key' => array(
array(
(object) array( 'foo' => 'bar', 'bar' => 'baz', 'abc' => 'xyz', 'key' => 'foo' ),
(object) array( 'foo' => 'foo', '123' => '456', 'lorem' => 'ipsum', 'key' => 'bar' ),
(object) array( 'foo' => 'baz', 'key' => 'value' ),
),
'foo',
'key',
array( 'foo' => 'bar', 'bar' => 'foo', 'value' => 'baz' ),
),
'objects with index key missing' => array(
array(
(object) array( 'foo' => 'bar', 'bar' => 'baz', 'abc' => 'xyz' ),
(object) array( 'foo' => 'foo', '123' => '456', 'lorem' => 'ipsum', 'key' => 'bar' ),
(object) array( 'foo' => 'baz', 'key' => 'value' ),
),
'foo',
'key',
array( 'bar' => 'foo', 'value' => 'baz', 'bar' ),
),
);
}
/**
* @dataProvider data_test_wp_list_pluck
*
* @param array $list List of objects or arrays.
* @param int|string $field Field from the object to place instead of the entire object
* @param int|string $index_key Field from the object to use as keys for the new array.
* @param array $expected Expected result.
*/
public function test_wp_list_pluck( $list, $field, $index_key, $expected ) {
$this->assertEqualSetsWithIndex( $expected, wp_list_pluck( $list, $field, $index_key ) );
}
public function data_test_wp_list_filter() {
return array(
'string instead of array' => array(
'foo',
array(),
'AND',
array(),
),
'object instead of array' => array(
(object) array( 'foo' ),
array(),
'AND',
array(),
),
'empty args' => array(
array( 'foo', 'bar' ),
array(),
'AND',
array( 'foo', 'bar' ),
),
'invalid operator' => array(
array(
(object) array( 'foo' => 'bar' ),
(object) array( 'foo' => 'baz' ),
),
array( 'foo' => 'bar' ),
'XOR',
array(),
),
'single argument to match' => array(
array(
(object) array( 'foo' => 'bar', 'bar' => 'baz', 'abc' => 'xyz', 'key' => 'foo' ),
(object) array( 'foo' => 'foo', '123' => '456', 'lorem' => 'ipsum', 'key' => 'bar' ),
(object) array( 'foo' => 'baz', 'key' => 'value' ),
(object) array( 'foo' => 'bar', 'key' => 'value' ),
),
array( 'foo' => 'bar' ),
'AND',
array(
0 => (object) array( 'foo' => 'bar', 'bar' => 'baz', 'abc' => 'xyz', 'key' => 'foo' ),
3 => (object) array( 'foo' => 'bar', 'key' => 'value' ),
),
),
'all must match' => array(
array(
(object) array( 'foo' => 'bar', 'bar' => 'baz', 'abc' => 'xyz', 'key' => 'foo' ),
(object) array( 'foo' => 'foo', '123' => '456', 'lorem' => 'ipsum', 'key' => 'bar' ),
(object) array( 'foo' => 'baz', 'key' => 'value', 'bar' => 'baz' ),
(object) array( 'foo' => 'bar', 'key' => 'value' ),
),
array( 'foo' => 'bar', 'bar' => 'baz' ),
'AND',
array(
0 => (object) array( 'foo' => 'bar', 'bar' => 'baz', 'abc' => 'xyz', 'key' => 'foo' ),
),
),
'any must match' => array(
array(
(object) array( 'foo' => 'bar', 'bar' => 'baz', 'abc' => 'xyz', 'key' => 'foo' ),
(object) array( 'foo' => 'foo', '123' => '456', 'lorem' => 'ipsum', 'key' => 'bar' ),
(object) array( 'foo' => 'baz', 'key' => 'value', 'bar' => 'baz' ),
(object) array( 'foo' => 'bar', 'key' => 'value' ),
),
array( 'key' => 'value', 'bar' => 'baz' ),
'OR',
array(
0 => (object) array( 'foo' => 'bar', 'bar' => 'baz', 'abc' => 'xyz', 'key' => 'foo' ),
2 => (object) array( 'foo' => 'baz', 'key' => 'value', 'bar' => 'baz' ),
3 => (object) array( 'foo' => 'bar', 'key' => 'value' ),
),
),
'none must match' => array(
array(
(object) array( 'foo' => 'bar', 'bar' => 'baz', 'abc' => 'xyz', 'key' => 'foo' ),
(object) array( 'foo' => 'foo', '123' => '456', 'lorem' => 'ipsum', 'key' => 'bar' ),
(object) array( 'foo' => 'baz', 'key' => 'value' ),
(object) array( 'foo' => 'bar', 'key' => 'value' ),
),
array( 'key' => 'value', 'bar' => 'baz' ),
'NOT',
array(
1 => (object) array( 'foo' => 'foo', '123' => '456', 'lorem' => 'ipsum', 'key' => 'bar' ),
),
),
);
}
/**
* @dataProvider data_test_wp_list_filter
*
* @param array $list An array of objects to filter.
* @param array $args An array of key => value arguments to match
* against each object.
* @param string $operator The logical operation to perform.
* @param array $expected Expected result.
*/
public function test_wp_list_filter( $list, $args, $operator, $expected ) {
$this->assertEqualSetsWithIndex( $expected, wp_list_filter( $list, $args, $operator ) );
}
public function data_test_wp_list_sort() {
return array(
'single orderby ascending' => array(
array(
array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
array( 'foo' => 'baz', 'key' => 'value' ),
),
'foo',
'ASC',
array(
array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
array( 'foo' => 'baz', 'key' => 'value' ),
array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
),
),
'single orderby descending' => array(
array(
array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
array( 'foo' => 'baz', 'key' => 'value' ),
),
'foo',
'DESC',
array(
array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
array( 'foo' => 'baz', 'key' => 'value' ),
array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
),
),
'single orderby array ascending' => array(
array(
array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
array( 'foo' => 'baz', 'key' => 'value' ),
),
array( 'foo' => 'ASC' ),
'IGNORED',
array(
array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
array( 'foo' => 'baz', 'key' => 'value' ),
array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
),
),
'single orderby array descending' => array(
array(
array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
array( 'foo' => 'baz', 'key' => 'value' ),
),
array( 'foo' => 'DESC' ),
'IGNORED',
array(
array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
array( 'foo' => 'baz', 'key' => 'value' ),
array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
),
),
'multiple orderby ascending' => array(
array(
array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
array( 'foo' => 'foo', 'key' => 'key' ),
array( 'foo' => 'baz', 'key' => 'key' ),
array( 'foo' => 'bar', 'key' => 'value' ),
),
array( 'key' => 'ASC', 'foo' => 'ASC' ),
'IGNORED',
array(
array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
array( 'foo' => 'baz', 'key' => 'key' ),
array( 'foo' => 'foo', 'key' => 'key' ),
array( 'foo' => 'bar', 'key' => 'value' ),
),
),
'multiple orderby descending' => array(
array(
array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
array( 'foo' => 'foo', 'key' => 'key' ),
array( 'foo' => 'baz', 'key' => 'key' ),
array( 'foo' => 'bar', 'key' => 'value' ),
),
array( 'key' => 'DESC', 'foo' => 'DESC' ),
'IGNORED',
array(
array( 'foo' => 'bar', 'key' => 'value' ),
array( 'foo' => 'foo', 'key' => 'key' ),
array( 'foo' => 'baz', 'key' => 'key' ),
array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
),
),
'multiple orderby mixed' => array(
array(
array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
array( 'foo' => 'foo', 'key' => 'key' ),
array( 'foo' => 'baz', 'key' => 'key' ),
array( 'foo' => 'bar', 'key' => 'value' ),
),
array( 'key' => 'DESC', 'foo' => 'ASC' ),
'IGNORED',
array(
array( 'foo' => 'bar', 'key' => 'value' ),
array( 'foo' => 'baz', 'key' => 'key' ),
array( 'foo' => 'foo', 'key' => 'key' ),
array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
),
),
);
}
/**
* @dataProvider data_test_wp_list_sort
*
* @param string|array $orderby Either the field name to order by or an array
* of multiple orderby fields as $orderby => $order.
* @param string $order Either 'ASC' or 'DESC'.
*/
public function test_wp_list_sort( $list, $orderby, $order, $expected ) {
$this->assertEquals( $expected, wp_list_sort( $list, $orderby, $order ) );
}
public function data_test_wp_list_sort_preserve_keys() {
return array(
'single orderby ascending' => array(
array(
'foobar' => array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
'foofoo' => array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
'foobaz' => array( 'foo' => 'baz', 'key' => 'value' ),
),
'foo',
'ASC',
array(
'foobar' => array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
'foobaz' => array( 'foo' => 'baz', 'key' => 'value' ),
'foofoo' => array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
),
),
'single orderby descending' => array(
array(
'foobar' => array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
'foofoo' => array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
'foobaz' => array( 'foo' => 'baz', 'key' => 'value' ),
),
'foo',
'DESC',
array(
'foofoo' => array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
'foobaz' => array( 'foo' => 'baz', 'key' => 'value' ),
'foobar' => array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
),
),
'single orderby array ascending' => array(
array(
'foobar' => array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
'foofoo' => array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
'foobaz' => array( 'foo' => 'baz', 'key' => 'value' ),
),
array( 'foo' => 'ASC' ),
'IGNORED',
array(
'foobar' => array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
'foobaz' => array( 'foo' => 'baz', 'key' => 'value' ),
'foofoo' => array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
),
),
'single orderby array descending' => array(
array(
'foobar' => array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
'foofoo' => array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
'foobaz' => array( 'foo' => 'baz', 'key' => 'value' ),
),
array( 'foo' => 'DESC' ),
'IGNORED',
array(
'foofoo' => array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
'foobaz' => array( 'foo' => 'baz', 'key' => 'value' ),
'foobar' => array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
),
),
'multiple orderby ascending' => array(
array(
'foobarfoo' => array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
'foofoobar' => array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
'foofookey' => array( 'foo' => 'foo', 'key' => 'key' ),
'foobazkey' => array( 'foo' => 'baz', 'key' => 'key' ),
'foobarvalue' => array( 'foo' => 'bar', 'key' => 'value' ),
),
array( 'key' => 'ASC', 'foo' => 'ASC' ),
'IGNORED',
array(
'foofoobar' => array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
'foobarfoo' => array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
'foobazkey' => array( 'foo' => 'baz', 'key' => 'key' ),
'foofookey' => array( 'foo' => 'foo', 'key' => 'key' ),
'foobarvalue' => array( 'foo' => 'bar', 'key' => 'value' ),
),
),
'multiple orderby descending' => array(
array(
'foobarfoo' => array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
'foofoobar' => array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
'foofookey' => array( 'foo' => 'foo', 'key' => 'key' ),
'foobazkey' => array( 'foo' => 'baz', 'key' => 'key' ),
'foobarvalue' => array( 'foo' => 'bar', 'key' => 'value' ),
),
array( 'key' => 'DESC', 'foo' => 'DESC' ),
'IGNORED',
array(
'foobarvalue' => array( 'foo' => 'bar', 'key' => 'value' ),
'foofookey' => array( 'foo' => 'foo', 'key' => 'key' ),
'foobazkey' => array( 'foo' => 'baz', 'key' => 'key' ),
'foobarfoo' => array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
'foofoobar' => array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
),
),
'multiple orderby mixed' => array(
array(
'foobarfoo' => array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
'foofoobar' => array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
'foofookey' => array( 'foo' => 'foo', 'key' => 'key' ),
'foobazkey' => array( 'foo' => 'baz', 'key' => 'key' ),
'foobarvalue' => array( 'foo' => 'bar', 'key' => 'value' ),
),
array( 'key' => 'DESC', 'foo' => 'ASC' ),
'IGNORED',
array(
'foobarvalue' => array( 'foo' => 'bar', 'key' => 'value' ),
'foobazkey' => array( 'foo' => 'baz', 'key' => 'key' ),
'foofookey' => array( 'foo' => 'foo', 'key' => 'key' ),
'foobarfoo' => array( 'foo' => 'bar', 'bar' => 'baz', 'key' => 'foo' ),
'foofoobar' => array( 'foo' => 'foo', 'lorem' => 'ipsum', 'key' => 'bar' ),
),
),
);
}
/**
* @dataProvider data_test_wp_list_sort_preserve_keys
*
* @param string|array $orderby Either the field name to order by or an array
* of multiple orderby fields as $orderby => $order.
* @param string $order Either 'ASC' or 'DESC'.
*/
public function test_wp_list_sort_preserve_keys( $list, $orderby, $order, $expected ) {
$this->assertEquals( $expected, wp_list_sort( $list, $orderby, $order, true ) );
}
public function test_wp_list_util_get_input() {
$input = array( 'foo', 'bar' );
$util = new WP_List_Util( $input );
$this->assertEqualSets( $input, $util->get_input() );
}
public function test_wp_list_util_get_output_immediately() {
$input = array( 'foo', 'bar' );
$util = new WP_List_Util( $input );
$this->assertEqualSets( $input, $util->get_output() );
}
public function test_wp_list_util_get_output() {
$expected = array( (object) array( 'foo' => 'bar', 'bar' => 'baz' ) );
$util = new WP_List_Util( array( (object) array( 'foo' => 'bar', 'bar' => 'baz' ), (object) array( 'bar' => 'baz' ) ) );
$actual = $util->filter( array( 'foo' => 'bar' ) );
$this->assertEqualSets( $expected, $actual );
$this->assertEqualSets( $expected, $util->get_output() );
}
}