WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Theme_JSON_Schema::migrate()

WP_Theme_JSON_Schema::migrate( array $theme_json, string $origin ): array

In this article

Back to top

Function that migrates a given theme.json structure to the last version.

Parameters

$theme_jsonarrayrequired
The structure to migrate.
$originstringoptional
What source of data this object represents.
One of 'blocks', 'default', 'theme', or 'custom'. Default 'theme'.

Return

array The structure in the last version.

Source

public static function migrate( $theme_json, $origin = 'theme' ) {
	if ( ! isset( $theme_json['version'] ) ) {
		$theme_json = array(
			'version' => WP_Theme_JSON::LATEST_SCHEMA,
		);
	}

	// Migrate each version in order starting with the current version.
	switch ( $theme_json['version'] ) {
		case 1:
			$theme_json = self::migrate_v1_to_v2( $theme_json );
			// Deliberate fall through. Once migrated to v2, also migrate to v3.
		case 2:
			$theme_json = self::migrate_v2_to_v3( $theme_json, $origin );
	}

	return $theme_json;
}

View all references View on Trac View on GitHub

UsesDescription
WP_Theme_JSON_Schema::migrate_v2_to_v3()wp-includes/class-wp-theme-json-schema.php

Migrates from v2 to v3.

WP_Theme_JSON_Schema::migrate_v1_to_v2()wp-includes/class-wp-theme-json-schema.php

Removes the custom prefixes for a few properties that were part of v1:

Used byDescription
WP_Theme_JSON::remove_insecure_properties()wp-includes/class-wp-theme-json.php

Removes insecure data from theme.json.

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

Constructor.

Changelog

VersionDescription
6.6.0Migrate up to v3 and add $origin parameter.
5.9.0Introduced.

User Contributed Notes

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