Docs4dev
Docs
wordpress / latest / functions / _wp_array_get.html

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

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.

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' ) );

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: null

Return

mixed The value from the path specified.

Source

File: wp-includes/functions.php. View all references

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

Used By

Used By Description
wp_typography_get_css_variable_inline_style() wp-includes/deprecated.php

Generates an inline style for a typography feature e.g. text decoration, text transform, and font style.
WP_Theme_JSON::set_spacing_sizes() wp-includes/class-wp-theme-json.php

Sets the spacingSizes array based on the spacingScale values from theme.json.
WP_Theme_JSON::get_styles_for_block() wp-includes/class-wp-theme-json.php

Gets the CSS rules for a particular block from theme.json.
WP_Theme_JSON::get_root_layout_rules() wp-includes/class-wp-theme-json.php

Outputs the CSS for layout rules on the root.
WP_Theme_JSON::get_layout_styles() wp-includes/class-wp-theme-json.php

Gets the CSS layout rules for a particular block from theme.json layout definitions.
WP_Style_Engine::parse_block_styles() wp-includes/style-engine/class-wp-style-engine.php

Returns classnames and CSS based on the values in a styles object.
WP_Style_Engine::get_individual_property_css_declarations() wp-includes/style-engine/class-wp-style-engine.php

Style value parser that returns a CSS definition array comprising style properties that have keys representing individual style properties, otherwise known as longhand CSS properties.
WP_Theme_JSON_Resolver::get_block_data() wp-includes/class-wp-theme-json-resolver.php

Gets the styles for blocks from the block.json file.
wp_skip_spacing_serialization() wp-includes/deprecated.php

Checks whether serialization of the current block’s spacing properties should occur.
wp_skip_border_serialization() wp-includes/deprecated.php

Checks whether serialization of the current block’s border properties should occur.
wp_skip_dimensions_serialization() wp-includes/deprecated.php

Checks whether serialization of the current block’s dimensions properties should occur.
WP_Theme_JSON::get_data() wp-includes/class-wp-theme-json.php

Returns a valid theme.json as provided by a theme.
WP_Theme_JSON::get_metadata_boolean() wp-includes/class-wp-theme-json.php

For metadata values that can either be booleans or paths to booleans, gets the value.
WP_Theme_JSON::get_svg_filters() wp-includes/class-wp-theme-json.php

Converts all filter (duotone) presets into SVGs.
wp_get_global_settings() wp-includes/global-styles-and-settings.php

Gets the settings resulting of merging core, theme, and user data.
wp_get_global_styles() wp-includes/global-styles-and-settings.php

Gets the styles resulting of merging core, theme, and user data.
WP_Theme_JSON_Schema::rename_settings() wp-includes/class-wp-theme-json-schema.php

Processes a settings array, renaming or moving properties.
WP_Theme_JSON::should_override_preset() wp-includes/class-wp-theme-json.php

Determines whether a presets should be overridden or not.
WP_Theme_JSON::get_default_slugs() wp-includes/class-wp-theme-json.php

Returns the default slugs for all the presets in an associative array whose keys are the preset paths and the leafs is the list of slugs.
WP_Theme_JSON::get_name_from_defaults() wp-includes/class-wp-theme-json.php

Gets a default‘s preset name by a provided slug.
WP_Theme_JSON::remove_insecure_properties() wp-includes/class-wp-theme-json.php

Removes insecure data from theme.json.
WP_Theme_JSON::remove_insecure_settings() wp-includes/class-wp-theme-json.php

Processes a setting node and returns the same node without the insecure settings.
WP_Theme_JSON::remove_insecure_styles() wp-includes/class-wp-theme-json.php

Processes a style node and returns the same node without the insecure styles.
WP_Theme_JSON::get_preset_classes() wp-includes/class-wp-theme-json.php

Creates new rulesets as classes for each preset value such as:
WP_Theme_JSON::get_settings_values_by_slug() wp-includes/class-wp-theme-json.php

Gets preset values keyed by slugs based on settings and metadata.
WP_Theme_JSON::get_settings_slugs() wp-includes/class-wp-theme-json.php

Similar to get_settings_values_by_slug, but doesn’t compute the value.
WP_Theme_JSON::do_opt_in_into_settings() wp-includes/class-wp-theme-json.php

Enables some settings.
WP_Theme_JSON::compute_theme_vars() wp-includes/class-wp-theme-json.php

Given an array of settings, extracts the CSS Custom Properties for the custom values and adds them to the $declarations array following the format:
WP_Theme_JSON::compute_style_properties() wp-includes/class-wp-theme-json.php

Given a styles array, it extracts the style properties and adds them to the $declarations array following the format:
WP_Theme_JSON::get_property_value() wp-includes/class-wp-theme-json.php

Returns the style property for the given path.
WP_Theme_JSON::merge() wp-includes/class-wp-theme-json.php

Merges new incoming data.
WP_Theme_JSON::__construct() wp-includes/class-wp-theme-json.php

Constructor.
WP_Theme_JSON::get_css_variables() wp-includes/class-wp-theme-json.php

Converts each styles section into a list of rulesets to be appended to the stylesheet.
block_has_support() wp-includes/blocks.php

Checks whether the current block type supports the feature requested.
wp_migrate_old_typography_shape() wp-includes/blocks.php

Converts typography keys declared under supports.* to supports.typography.*.

Changelog

Version Description
5.6.0 Introduced.

© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/_wp_array_get