WP_REST_Widget_Types_Controller::get_widget_preview( string $widget, array $instance )

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Returns the output of WP_Widget::widget() when called with the provided instance. Used by encode_form_data() to preview a widget.

Parameters

$widget

(string) (Required) The widget's PHP class name (see class-wp-widget.php).

$instance

(array) (Required) Widget instance settings.

Return

(string)

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-widget-types-controller.php 

private function get_widget_preview( $widget, $instance ) {
		ob_start();
		the_widget( $widget, $instance );
		return ob_get_clean();
	}

Uses

Uses Description
wp-includes/widgets.php: the_widget()

Output an arbitrary widget as a template tag.

Used By

Used By Description
wp-includes/rest-api/endpoints/class-wp-rest-widget-types-controller.php: WP_REST_Widget_Types_Controller::encode_form_data()

An RPC-style endpoint which can be used by clients to turn user input in a widget admin form into an encoded instance object.

Changelog

Version Description
5.8.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_widget_types_controller/get_widget_preview