WP_Theme_JSON::should_override_preset( array $theme_json, array $path, bool|array $override ): bool|null

Compatibility

Deprecated in WordPress 6.0.0. Use {@see 'get_metadata_boolean'} instead.

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$theme_jsonarray

The theme.json like structure to inspect.

$patharray

Path to inspect.

$overridebool|array

Data to compute whether to override the preset.

Return value

bool|null

True if the preset should override the defaults, false if not. Null if the override parameter is invalid.

Performance profile

How much work a call to WP_Theme_JSON::should_override_preset() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

11–36

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 41.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()one call below WP_Theme_JSON::should_override_preset()

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Theme_JSON::should_override_preset() can have, taken from its control-flow graph on PHP 8.5.

Uses · 2

• _deprecated_function()Marks a function as deprecated and inform when it has been used.
• _wp_array_get()Accesses an array in depth based on a path of keys.

Source code

View on Trac ↗View on GitHub ↗

4512	protected static function should_override_preset( $theme_json, $path, $override ) {4513		_deprecated_function( __METHOD__, '6.0.0', 'get_metadata_boolean' );4514 4515		if ( is_bool( $override ) ) {4516			return $override;4517		}4518 4519		/*4520		 * The relationship between whether to override the defaults4521		 * and whether the defaults are enabled is inverse:4522		 *4523		 * - If defaults are enabled  => theme presets should not be overridden4524		 * - If defaults are disabled => theme presets should be overridden4525		 *4526		 * For example, a theme sets defaultPalette to false,4527		 * making the default palette hidden from the user.4528		 * In that case, we want all the theme presets to be present,4529		 * so they should override the defaults.4530		 */4531		if ( is_array( $override ) ) {4532			$value = _wp_array_get( $theme_json, array_merge( $path, $override ) );4533			if ( isset( $value ) ) {4534				return ! $value;4535			}4536 4537			// Search the top-level key if none was found for this node.4538			$value = _wp_array_get( $theme_json, array_merge( array( 'settings' ), $override ) );4539			if ( isset( $value ) ) {4540				return ! $value;4541			}4542 4543			return true;4544		}4545 4546		return null;4547	}

Changelog

Introduced in 5.9.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-theme-json.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.