* Helper functions to work with multidimensional arrays easier.
* Determine whether the given value is array accessible.
* @param mixed $value Checkin to accessible.
function wpforms_list_accessible( $value ) {
return is_array( $value ) || $value instanceof ArrayAccess;
* Set an array item to a given value using "dot" notation.
* If no key is given to the method, the entire array will be replaced.
* @param array $array Existing array.
* @param string $key Path to set.
* @param mixed $value Value to set.
* @param string $separator Separator.
* @return array New array.
function wpforms_list_set( $array, $key, $value, $separator = '.' ) {
if ( ! wpforms_list_accessible( $array ) ) {
$keys = explode( $separator, $key );
$count_keys = count( $keys );
$values = array_values( $keys );
$last_key = $values[ $count_keys - 1 ];
for ( $i = 0; $i < $count_keys - 1; $i ++ ) {
$tmp_array = &$tmp_array[ $k ];
$tmp_array[ $last_key ] = $value;
* Determine if the given key exists in the provided array.
* @param ArrayAccess|array $array Existing array.
* @param string|int $key To check.
function wpforms_list_exists( $array, $key ) {
if ( ! wpforms_list_accessible( $array ) ) {
if ( $array instanceof ArrayAccess ) {
return $array->offsetExists( $key );
return array_key_exists( $key, $array );
* Get an item from an array using "dot" notation.
* @param ArrayAccess|array $array Where we want to get.
* @param string $key Key with dot's.
* @param mixed $default Value.
function wpforms_list_get( $array, $key, $default = null ) {
if ( ! wpforms_list_accessible( $array ) ) {
if ( ! is_string( $key ) ) {
if ( wpforms_list_exists( $array, $key ) ) {
foreach ( explode( '.', $key ) as $segment ) {
if ( wpforms_list_accessible( $array ) && wpforms_list_exists( $array, $segment ) ) {
$array = $array[ $segment ];
* Check if an item exists in an array using "dot" notation.
* @param ArrayAccess|array $array To check.
* @param string $key Keys with dot's.
function wpforms_list_has( $array, $key ) {
if ( $key === null || ! is_string( $key ) ) {
if ( wpforms_list_exists( $array, $key ) ) {
foreach ( explode( '.', $key ) as $segment ) {
if ( wpforms_list_accessible( $array ) && wpforms_list_exists( $array, $segment ) ) {
$array = $array[ $segment ];
* Determine if an array is associative.
* An array is "associative" if it doesn't have sequential numerical keys beginning with zero.
* @param array $array To check.
function wpforms_list_is_assoc( $array ) {
$keys = array_keys( $array );
return array_keys( $keys ) !== $keys;
* Get a subset of the items from the given array.
* @param array $array To get.
* @param array|string $keys To filter.
function wpforms_list_only( $array, $keys ) {
return array_intersect_key( $array, array_flip( (array) $keys ) );
* Remove one or many array items from a given array using "dot" notation.
* @param array $array To forget.
* @param array|string $keys To exclude.
function wpforms_list_forget( $array, $keys ) {
if ( count( $keys ) === 0 ) {
foreach ( $keys as $key ) {
// if the exact key exists in the top-level, remove it.
if ( wpforms_list_exists( $array, $key ) ) {
$parts = explode( '.', $key );
$count_keys = count( $parts );
$values = array_values( $parts );
$last_key = $values[ $count_keys - 1 ];
for ( $i = 0; $i < $count_keys - 1; $i ++ ) {
$tmp_array = &$tmp_array[ $k ];
unset( $tmp_array[ $last_key ] );
* Insert a value or key/value pair after a specific key in an array.
* If key doesn't exist, value is appended to the end of the array.
* @param array $target Array where to insert.
* @param string $key Insert after key.
* @param array $data Array to insert.
function wpforms_list_insert_after( array $target, string $key, array $data ): array {
return wpforms_list_insert( $target, $key, $data, 'after' );
* Insert a value or key/value pair before a specific key in an array.
* If key doesn't exist, value is prepended to the beginning of the array.
* @param array $target Array where to insert.
* @param string $key Insert before key.
* @param array $data Array to insert.
function wpforms_list_insert_before( array $target, string $key, array $data ): array {
return wpforms_list_insert( $target, $key, $data, 'before' );
* Insert a value or key/value pair before or after a specific key in an array.
* If key doesn't exist, value is appended to the end of the array.
* @param array $target Array where to insert.
* @param string $key Insert before/after key.
* @param array $data Array to insert.
* @param string $position Position to insert before/after.
function wpforms_list_insert( array $target, string $key, array $data, string $position ): array {
$position = strtolower( $position );
$keys = array_keys( $target );
$index = array_search( $key, $keys, true );
if ( $position === 'before' ) {
$pos = $index === false ? 0 : $index;
} elseif ( $position === 'after' ) {
$pos = $index === false ? count( $target ) : $index + 1;
return array_merge( array_slice( $target, 0, $pos ), $data, array_slice( $target, $pos ) );
* Cleanup $items array recursively removing from it all keys not existing in the $default array.
* @param array $items Items.
* @param array $default Default items.
function wpforms_list_intersect_key( $items, $default ) {
if ( ! is_array( $items ) ) {
$items = array_intersect_key( $items, $default );
foreach ( $items as $key => &$item ) {
$item = wpforms_list_intersect_key( $item, $default[ $key ] );
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
