Alert: This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

_wp_array_get( array $array, array $path, mixed $default = null )

Accesses an array in depth based on a path of keys.


Description

It is the PHP equivalent of JavaScript’s lodash.get() and mirroring it may help other components retain some symmetry between client and server implementations.

Example usage:

$array = array(
    'a' => array(
        'b' => array(
            'c' => 1,
        ),
    ),
);
_wp_array_get( $array, array( 'a', 'b', 'c' ) );

Top ↑

Parameters

$array

(array) (Required) An array from which we want to retrieve some information.

$path

(array) (Required) An array of keys describing the path with which to retrieve information.

$default

(mixed) (Optional) The return value if the path does not exist within the array, or if $array or $path are not arrays.

Default value: null


Top ↑

Return

(mixed) The value from the path specified.


Top ↑

Source

File: wp-includes/functions.php

function _wp_array_get( $array, $path, $default = null ) {
	// Confirm $path is valid.
	if ( ! is_array( $path ) || 0 === count( $path ) ) {
		return $default;
	}

	foreach ( $path as $path_element ) {
		if (
			! is_array( $array ) ||
			( ! is_string( $path_element ) && ! is_integer( $path_element ) && ! is_null( $path_element ) ) ||
			! array_key_exists( $path_element, $array )
		) {
			return $default;
		}
		$array = $array[ $path_element ];
	}

	return $array;
}


Top ↑

Changelog

Changelog
Version Description
5.6.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.