wp_attach_theme_preview_middleware()

Adds a middleware to apiFetch to set the theme for the preview.

Description

This adds a wp_theme_preview URL parameter to API requests from the Site Editor, so they also respond as if the theme is set to the value of the parameter.

Source

function wp_attach_theme_preview_middleware() {
	// Don't allow non-admins to preview themes.
	if ( ! current_user_can( 'switch_themes' ) ) {
		return;
	}

	wp_add_inline_script(
		'wp-api-fetch',
		sprintf(
			'wp.apiFetch.use( wp.apiFetch.createThemePreviewMiddleware( %s ) );',
			wp_json_encode( sanitize_text_field( wp_unslash( $_GET['wp_theme_preview'] ) ) )
		),
		'after'
	);
}

View all references View on Trac View on GitHub

Uses	Description
wp_add_inline_script()`wp-includes/functions.wp-scripts.php`	Adds extra code to a registered script.
wp_json_encode()`wp-includes/functions.php`	Encodes a variable into JSON, with some confidence checks.
current_user_can()`wp-includes/capabilities.php`	Returns whether the current user has the specified capability.
sanitize_text_field()`wp-includes/formatting.php`	Sanitizes a string from user input or from the database.
wp_unslash()`wp-includes/formatting.php`	Removes slashes from a string or recursively removes slashes from strings within an array.

Show 3 more Show less

Changelog

Version	Description
6.3.0	Introduced.

In this article

Description

Source

Changelog

User Contributed Notes

wp_attach_theme_preview_middleware()

In this article

Description

Source

Related

Changelog

User Contributed Notes