Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add _wp_array_set function #1263

Closed
wants to merge 2 commits into from
Closed

Add _wp_array_set function #1263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09dafb7
Add _wp_array_set function
oandregal May 18, 2021
6fb5337
Add unit tests
oandregal May 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions src/wp-includes/functions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4626,6 +4626,65 @@ function _wp_array_get( $array, $path, $default = null ) {
return $array;
}

/**
* Sets an array in depth based on a path of keys.
*
* It is the PHP equivalent of JavaScript's `lodash.set()` and mirroring it may help other components
* retain some symmetry between client and server implementations.
*
* Example usage:
*
* $array = array();
* _wp_array_set( $array, array( 'a', 'b', 'c', 1 );
* $array becomes:
* array(
* 'a' => array(
* 'b' => array(
* 'c' => 1,
* ),
* ),
* );
*
* @param array $array An array that we want to mutate to include a specific value in a path.
* @param array $path An array of keys describing the path that we want to mutate.
* @param mixed $value The value that will be set.
*/
function _wp_array_set( &$array, $path, $value = null ) {
// Confirm $array is valid.
if ( ! is_array( $array ) ) {
return;
}

// Confirm $path is valid.
if ( ! is_array( $path ) ) {
return;
}
$path_length = count( $path );
if ( 0 === $path_length ) {
return;
}
foreach ( $path as $path_element ) {
if (
! is_string( $path_element ) && ! is_integer( $path_element ) &&
! is_null( $path_element )
) {
return;
}
}

for ( $i = 0; $i < $path_length - 1; ++$i ) {
$path_element = $path[ $i ];
if (
! array_key_exists( $path_element, $array ) ||
! is_array( $array[ $path_element ] )
) {
$array[ $path_element ] = array();
}
$array = &$array[ $path_element ]; // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.VariableRedeclaration
}
$array[ $path[ $i ] ] = $value;
}

/**
* Determines if the variable is a numeric-indexed array.
*
Expand Down
130 changes: 130 additions & 0 deletions tests/phpunit/tests/class-wp-array-set-test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
<?php
/**
* _wp_array_set.
*
* @package WordPress
*/

/**
* Test _wp_array_set function.
*
* @package WordPress
*/
class WP_Array_Set_Test extends WP_UnitTestCase {
/**
* Test _wp_array_set() with simple non subtree path.
*/
public function test_simple_not_subtree_set() {
$test_array = array();
_wp_array_set( $test_array, array( 'a' ), 1 );
$this->assertSame(
$test_array,
array( 'a' => 1 )
);

$test_array = array( 'a' => 2 );
_wp_array_set( $test_array, array( 'a' ), 3 );
$this->assertSame(
$test_array,
array( 'a' => 3 )
);

$test_array = array( 'b' => 1 );
_wp_array_set( $test_array, array( 'a' ), 3 );
$this->assertSame(
$test_array,
array(
'b' => 1,
'a' => 3,
)
);
}

/**
* Test _wp_array_set() with subtree paths.
*/
public function test_subtree_set() {
$test_array = array();
_wp_array_set( $test_array, array( 'a', 'b', 'c' ), 1 );
$this->assertSame(
$test_array,
array( 'a' => array( 'b' => array( 'c' => 1 ) ) )
);

$test_array = array( 'b' => 3 );
_wp_array_set( $test_array, array( 'a', 'b', 'c' ), 1 );
$this->assertSame(
$test_array,
array(
'b' => 3,
'a' => array( 'b' => array( 'c' => 1 ) ),
)
);

$test_array = array(
'b' => 3,
'a' => 1,
);
_wp_array_set( $test_array, array( 'a', 'b', 'c' ), 1 );
$this->assertSame(
$test_array,
array(
'b' => 3,
'a' => array( 'b' => array( 'c' => 1 ) ),
)
);

$test_array = array(
'b' => 3,
'a' => array(),
);
_wp_array_set( $test_array, array( 'a', 'b', 'c' ), 1 );
$this->assertSame(
$test_array,
array(
'b' => 3,
'a' => array( 'b' => array( 'c' => 1 ) ),
)
);
}

/**
* Test _wp_array_set() with invalid parameters.
*/
public function test_invalid_parameters_set() {
$test = 3;
_wp_array_set( $test, array( 'a' ), 1 );
$this->assertSame(
$test,
3
);

$test_array = array( 'a' => 2 );
_wp_array_set( $test_array, 'a', 3 );
$this->assertSame(
$test_array,
array( 'a' => 2 )
);

$test_array = array( 'a' => 2 );
_wp_array_set( $test_array, null, 3 );
$this->assertSame(
$test_array,
array( 'a' => 2 )
);

$test_array = array( 'a' => 2 );
_wp_array_set( $test_array, array(), 3 );
$this->assertSame(
$test_array,
array( 'a' => 2 )
);

$test_array = array( 'a' => 2 );
_wp_array_set( $test_array, array( 'a', array() ), 3 );
$this->assertSame(
$test_array,
array( 'a' => 2 )
);
}
}