WP_REST_Widgets_Controller

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 5

Every hook that fires from inside WP_REST_Widgets_Controller, in the order it appears in the class, grouped by the method that fires it.

Properties · 2

$widgets_retrievedboolprotected

Tracks whether retrieve_widgets() has been called in the current request.

$allow_batcharrayprotected

Whether the controller supports batching.

Methods · 20

• __construct()Widgets controller constructor.
• register_routes()Registers the widget routes for the controller.
• get_items_permissions_check()Checks if a given request has access to get widgets.
• get_items()Retrieves a collection of widgets.
• get_item_permissions_check()Checks if a given request has access to get a widget.
• check_read_sidebar_permission()Checks if a sidebar can be read publicly.
• get_item()Gets an individual widget.
• create_item_permissions_check()Checks if a given request has access to create widgets.
• create_item()Creates a widget.
• update_item_permissions_check()Checks if a given request has access to update widgets.
• update_item()Updates an existing widget.
• delete_item_permissions_check()Checks if a given request has access to delete widgets.
• delete_item()Deletes a widget.
• permissions_check()Performs a permissions check for managing widgets.
• retrieve_widgets()Looks for "lost" widgets once per request.
• save_widget()Saves the widget in the request object.
• prepare_item_for_response()Prepares the widget for the REST response.
• prepare_links()Prepares links for the widget.
• get_collection_params()Gets the list of collection params.
• get_item_schema()Retrieves the widget's schema, conforming to JSON Schema.

Source code

View on Trac ↗View on GitHub ↗

17class WP_REST_Widgets_Controller extends WP_REST_Controller {18 19	/**20	 * Tracks whether {@see retrieve_widgets()} has been called in the current request.21	 *22	 * @since 5.9.023	 * @var bool24	 */25	protected $widgets_retrieved = false;26 27	/**28	 * Whether the controller supports batching.29	 *30	 * @since 5.9.031	 * @var array32	 */33	protected $allow_batch = array( 'v1' => true );34 35	/**36	 * Widgets controller constructor.37	 *38	 * @since 5.8.039	 */40	public function __construct() {41		$this->namespace = 'wp/v2';42		$this->rest_base = 'widgets';43	}44 45	/**46	 * Registers the widget routes for the controller.47	 *48	 * @since 5.8.049	 */50	public function register_routes() {51		register_rest_route(52			$this->namespace,53			$this->rest_base,54			array(55				array(56					'methods'             => WP_REST_Server::READABLE,57					'callback'            => array( $this, 'get_items' ),58					'permission_callback' => array( $this, 'get_items_permissions_check' ),59					'args'                => $this->get_collection_params(),60				),61				array(62					'methods'             => WP_REST_Server::CREATABLE,63					'callback'            => array( $this, 'create_item' ),64					'permission_callback' => array( $this, 'create_item_permissions_check' ),65					'args'                => $this->get_endpoint_args_for_item_schema(),66				),67				'allow_batch' => $this->allow_batch,68				'schema'      => array( $this, 'get_public_item_schema' ),69			)70		);71 72		register_rest_route(73			$this->namespace,74			$this->rest_base . '/(?P<id>[\w\-]+)',75			array(76				array(77					'methods'             => WP_REST_Server::READABLE,78					'callback'            => array( $this, 'get_item' ),79					'permission_callback' => array( $this, 'get_item_permissions_check' ),80					'args'                => array(81						'context' => $this->get_context_param( array( 'default' => 'view' ) ),82					),83				),84				array(85					'methods'             => WP_REST_Server::EDITABLE,86					'callback'            => array( $this, 'update_item' ),87					'permission_callback' => array( $this, 'update_item_permissions_check' ),88					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),89				),90				array(91					'methods'             => WP_REST_Server::DELETABLE,92					'callback'            => array( $this, 'delete_item' ),93					'permission_callback' => array( $this, 'delete_item_permissions_check' ),94					'args'                => array(95						'force' => array(96							'description' => __( 'Whether to force removal of the widget, or move it to the inactive sidebar.' ),

Changelog

Introduced in 5.8.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.9.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.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.