WP_Theme_JSON::set_spacing_sizes(): null|void

In this article

Sets the spacingSizes array based on the spacingScale values from theme.json.

Return

null|void

Source

 * @since 5.9.0
 * @deprecated 6.0.0 Use 'get_metadata_boolean' instead.
 *
 * @param array      $theme_json The theme.json like structure to inspect.
 * @param array      $path       Path to inspect.
 * @param bool|array $override   Data to compute whether to override the preset.
 * @return bool
 */
protected static function should_override_preset( $theme_json, $path, $override ) {
	_deprecated_function( __METHOD__, '6.0.0', 'get_metadata_boolean' );

	if ( is_bool( $override ) ) {
		return $override;
	}

	/*
	 * The relationship between whether to override the defaults
	 * and whether the defaults are enabled is inverse:
	 *
	 * - If defaults are enabled  => theme presets should not be overridden
	 * - If defaults are disabled => theme presets should be overridden
	 *
	 * For example, a theme sets defaultPalette to false,
	 * making the default palette hidden from the user.
	 * In that case, we want all the theme presets to be present,
	 * so they should override the defaults.
	 */
	if ( is_array( $override ) ) {
		$value = _wp_array_get( $theme_json, array_merge( $path, $override ) );
		if ( isset( $value ) ) {
			return ! $value;
		}

		// Search the top-level key if none was found for this node.
		$value = _wp_array_get( $theme_json, array_merge( array( 'settings' ), $override ) );
		if ( isset( $value ) ) {
			return ! $value;
		}

		return true;
	}
}

/**
 * Returns the default slugs for all the presets in an associative array
 * whose keys are the preset paths and the leaves is the list of slugs.
 *
 * For example:
 *
 *     array(
 *       'color' => array(
 *         'palette'   => array( 'slug-1', 'slug-2' ),
 *         'gradients' => array( 'slug-3', 'slug-4' ),
 *       ),
 *     )
 *
 * @since 5.9.0
 *
 * @param array $data      A theme.json like structure.
 * @param array $node_path The path to inspect. It's 'settings' by default.
 * @return array
 */
protected static function get_default_slugs( $data, $node_path ) {
	$slugs = array();

	foreach ( static::PRESETS_METADATA as $metadata ) {
		$path = $node_path;
		foreach ( $metadata['path'] as $leaf ) {
			$path[] = $leaf;
		}
		$path[] = 'default';

		$preset = _wp_array_get( $data, $path, null );
		if ( ! isset( $preset ) ) {
			continue;
		}

		$slugs_for_preset = array();
		foreach ( $preset as $item ) {
			if ( isset( $item['slug'] ) ) {
				$slugs_for_preset[] = $item['slug'];
			}
		}

		_wp_array_set( $slugs, $metadata['path'], $slugs_for_preset );
	}

	return $slugs;
}

/**
 * Gets a `default`'s preset name by a provided slug.
 *
 * @since 5.9.0
 *
 * @param string $slug The slug we want to find a match from default presets.
 * @param array  $base_path The path to inspect. It's 'settings' by default.
 * @return string|null
 */
protected function get_name_from_defaults( $slug, $base_path ) {
	$path            = $base_path;
	$path[]          = 'default';
	$default_content = _wp_array_get( $this->theme_json, $path, null );
	if ( ! $default_content ) {
		return null;
	}
	foreach ( $default_content as $item ) {
		if ( $slug === $item['slug'] ) {
			return $item['name'];
		}
	}
	return null;
}

/**

Changelog

VersionDescription
6.1.0Introduced.

User Contributed Notes

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