vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2025-10-16 12:05:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

General: Add _wp_array_set function.

Browse Source 
This adds the _wp_array_set function, which is the counterpart of the existing _wp_array_get.
This utility is to be used by the Global Settings work.

Props nosolosw, jorgefilipecosta.
See #53175.


git-svn-id: https://develop.svn.wordpress.org/trunk@50958 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Riad Benguella 2021-05-24 08:29:03 +00:00
parent d28766f8f2
commit c0084bccca
2 changed files with 189 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
src/wp-includes/functions.php
View File

@ -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.
*

130
tests/phpunit/tests/class-wp-array-set-test.php Normal file
View File

@ -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 )
);
}
}