WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Widget_Types_Controller::get_widget_preview()

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

In this article

Back to top

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

$widgetstringrequired
The widget’s PHP class name (see class-wp-widget.php).
$instancearrayrequired
Widget instance settings.

Return

string

Source

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

View all references View on Trac View on GitHub

UsesDescription
the_widget()wp-includes/widgets.php

Output an arbitrary widget as a template tag.

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

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

VersionDescription
5.8.0Introduced.

User Contributed Notes

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