WP_Theme_JSON::get_metadata_boolean() – Method

WP_Theme_JSON::get_metadata_boolean( array $data, bool|array $path, bool $default_value = false ): bool

For metadata values that can either be booleans or paths to booleans, gets the value.

Description

$data = array( ‘color’ => array( ‘defaultPalette’ => true ) );

static::get_metadata_boolean( $data, false );
// => false

static::get_metadata_boolean( $data, array( 'color', 'defaultPalette' ) );
// => true

Parameters

$dataarrayrequired: The data to inspect.
$pathbool|arrayrequired: Boolean or path to a boolean.
$default_valuebooloptional: Default value if the referenced path is missing.

Default:false

Return

bool Value of boolean metadata.

Source

*       [
*         'path'     => ['path', 'to', 'other', 'node' ],
*         'selector' => 'CSS selector for other node',
*         'duotone'  => null
*       ],
*     ]
*
* @since 5.8.0
* @since 6.6.0 Added options array for modifying generated nodes.
*
* @param array $theme_json The tree to extract style nodes from.
* @param array $selectors  List of selectors per block.
* @param array $options {
*     Optional. An array of options for now used for internal purposes only (may change without notice).

View all references View on Trac View on GitHub

Changelog

Version	Description
6.0.0	Introduced.

User Contributed Notes

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