WP_Theme_JSON_Resolver::get_user_data(): WP_Theme_JSON

Compatibility

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

Return value

WP_Theme_JSON

Entity that holds styles for user data.

Performance profile

How much work a call to WP_Theme_JSON_Resolver::get_user_data() 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

9–56

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

Plugin surface

1 hook

Third-party callbacks on 'wp_theme_json_data_user' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• serializeserialisationjson_decode()called directly

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

What one call costs · 13 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while WP_Theme_JSON_Resolver::get_user_data() runs, in this order:

1. 1
   apply_filters( wp_theme_json_data_user )filterline 572 (+21 into the body)

   Filters the data provided by the user for global styles & settings.

2. 2
   apply_filters( wp_theme_json_data_user )filterline 601 (+50 into the body)

   Filters the data provided by the user for global styles & settings.

Uses · 7

• wp_get_theme()Gets a WP_Theme object for a theme.
• wp_trigger_error()Generates a user-level error/warning/notice/deprecation message.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• static::has_same_registered_blocks()
• static::get_user_data_from_wp_global_styles()
• WP_Theme_JSON_Data::__construct()Constructor.
• WP_Theme_JSON::__construct()Constructor.

Used by · 1

• wp_generate_block_templates_export_file()Creates an export of the current templates and template parts from the site editor at the specified path in a ZIP file.

Source code

View on Trac ↗View on GitHub ↗

551	public static function get_user_data() {552		if ( null !== static::$user && static::has_same_registered_blocks( 'user' ) ) {553			return static::$user;554		}555 556		$config   = array();557		$user_cpt = static::get_user_data_from_wp_global_styles( wp_get_theme() );558 559		if ( array_key_exists( 'post_content', $user_cpt ) ) {560			$decoded_data = json_decode( $user_cpt['post_content'], true );561 562			$json_decoding_error = json_last_error();563			if ( JSON_ERROR_NONE !== $json_decoding_error ) {564				wp_trigger_error( __METHOD__, 'Error when decoding a theme.json schema for user data. ' . json_last_error_msg() );565				/**566				 * Filters the data provided by the user for global styles & settings.567				 *568				 * @since 6.1.0569				 *570				 * @param WP_Theme_JSON_Data $theme_json Class to access and update the underlying data.571				 */572				$theme_json = apply_filters( 'wp_theme_json_data_user', new WP_Theme_JSON_Data( $config, 'custom' ) );573 574				/*575				 * Backward compatibility for extenders returning a WP_Theme_JSON_Data576				 * compatible class that is not a WP_Theme_JSON_Data object.577				 */578				if ( $theme_json instanceof WP_Theme_JSON_Data ) {579					return $theme_json->get_theme_json();580				} else {581					$config = $theme_json->get_data();582					return new WP_Theme_JSON( $config, 'custom' );583				}584			}585 586			/*587			 * Very important to verify that the flag isGlobalStylesUserThemeJSON is true.588			 * If it's not true then the content was not escaped and is not safe.589			 */590			if (591				is_array( $decoded_data ) &&592				isset( $decoded_data['isGlobalStylesUserThemeJSON'] ) &&593				$decoded_data['isGlobalStylesUserThemeJSON']594			) {595				unset( $decoded_data['isGlobalStylesUserThemeJSON'] );596				$config = $decoded_data;597			}598		}599 600		/** This filter is documented in wp-includes/class-wp-theme-json-resolver.php */601		$theme_json = apply_filters( 'wp_theme_json_data_user', new WP_Theme_JSON_Data( $config, 'custom' ) );602 603		/*604		 * Backward compatibility for extenders returning a WP_Theme_JSON_Data605		 * compatible class that is not a WP_Theme_JSON_Data object.606		 */607		if ( $theme_json instanceof WP_Theme_JSON_Data ) {608			static::$user = $theme_json->get_theme_json();609		} else {610			$config       = $theme_json->get_data();611			static::$user = new WP_Theme_JSON( $config, 'custom' );612		}613 614		return static::$user;615	}

Changelog

Introduced in 5.9.0. Unchanged from 6.7.7 through 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 6.7.7 tag, from src/wp-includes/class-wp-theme-json-resolver.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.