mirror of
https://github.com/WordPress/WordPress.git
synced 2024-09-10 22:58:33 +02:00
07139653b9
While the new name is much better, it doesn't fully tell what will happen when invoked nor does it fully solve the root problems. Why? The function is doing too much. And naming is hard. Props azaozz, desrosj, andraganescu, zieladam, hellofromTonya. See #53811. Built from https://develop.svn.wordpress.org/trunk@51791 git-svn-id: http://core.svn.wordpress.org/trunk@51398 1a063a9b-81f0-0310-95a4-ce76da25c4cd
808 lines
24 KiB
PHP
808 lines
24 KiB
PHP
<?php
|
|
/**
|
|
* REST API: WP_REST_Widgets_Controller class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage REST_API
|
|
* @since 5.8.0
|
|
*/
|
|
|
|
/**
|
|
* Core class to access widgets via the REST API.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @see WP_REST_Controller
|
|
*/
|
|
class WP_REST_Widgets_Controller extends WP_REST_Controller {
|
|
|
|
/**
|
|
* Widgets controller constructor.
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function __construct() {
|
|
$this->namespace = 'wp/v2';
|
|
$this->rest_base = 'widgets';
|
|
}
|
|
|
|
/**
|
|
* Registers the widget routes for the controller.
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function register_routes() {
|
|
register_rest_route(
|
|
$this->namespace,
|
|
$this->rest_base,
|
|
array(
|
|
array(
|
|
'methods' => WP_REST_Server::READABLE,
|
|
'callback' => array( $this, 'get_items' ),
|
|
'permission_callback' => array( $this, 'get_items_permissions_check' ),
|
|
'args' => $this->get_collection_params(),
|
|
),
|
|
array(
|
|
'methods' => WP_REST_Server::CREATABLE,
|
|
'callback' => array( $this, 'create_item' ),
|
|
'permission_callback' => array( $this, 'create_item_permissions_check' ),
|
|
'args' => $this->get_endpoint_args_for_item_schema(),
|
|
),
|
|
'allow_batch' => array( 'v1' => true ),
|
|
'schema' => array( $this, 'get_public_item_schema' ),
|
|
)
|
|
);
|
|
|
|
register_rest_route(
|
|
$this->namespace,
|
|
$this->rest_base . '/(?P<id>[\w\-]+)',
|
|
array(
|
|
array(
|
|
'methods' => WP_REST_Server::READABLE,
|
|
'callback' => array( $this, 'get_item' ),
|
|
'permission_callback' => array( $this, 'get_item_permissions_check' ),
|
|
'args' => array(
|
|
'context' => $this->get_context_param( array( 'default' => 'view' ) ),
|
|
),
|
|
),
|
|
array(
|
|
'methods' => WP_REST_Server::EDITABLE,
|
|
'callback' => array( $this, 'update_item' ),
|
|
'permission_callback' => array( $this, 'update_item_permissions_check' ),
|
|
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
|
|
),
|
|
array(
|
|
'methods' => WP_REST_Server::DELETABLE,
|
|
'callback' => array( $this, 'delete_item' ),
|
|
'permission_callback' => array( $this, 'delete_item_permissions_check' ),
|
|
'args' => array(
|
|
'force' => array(
|
|
'description' => __( 'Whether to force removal of the widget, or move it to the inactive sidebar.' ),
|
|
'type' => 'boolean',
|
|
),
|
|
),
|
|
),
|
|
'allow_batch' => array( 'v1' => true ),
|
|
'schema' => array( $this, 'get_public_item_schema' ),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Checks if a given request has access to get widgets.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return true|WP_Error True if the request has read access, WP_Error object otherwise.
|
|
*/
|
|
public function get_items_permissions_check( $request ) {
|
|
return $this->permissions_check( $request );
|
|
}
|
|
|
|
/**
|
|
* Retrieves a collection of widgets.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
|
|
*/
|
|
public function get_items( $request ) {
|
|
retrieve_widgets();
|
|
|
|
$prepared = array();
|
|
|
|
foreach ( wp_get_sidebars_widgets() as $sidebar_id => $widget_ids ) {
|
|
if ( isset( $request['sidebar'] ) && $sidebar_id !== $request['sidebar'] ) {
|
|
continue;
|
|
}
|
|
|
|
foreach ( $widget_ids as $widget_id ) {
|
|
$response = $this->prepare_item_for_response( compact( 'sidebar_id', 'widget_id' ), $request );
|
|
|
|
if ( ! is_wp_error( $response ) ) {
|
|
$prepared[] = $this->prepare_response_for_collection( $response );
|
|
}
|
|
}
|
|
}
|
|
|
|
return new WP_REST_Response( $prepared );
|
|
}
|
|
|
|
/**
|
|
* Checks if a given request has access to get a widget.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return true|WP_Error True if the request has read access, WP_Error object otherwise.
|
|
*/
|
|
public function get_item_permissions_check( $request ) {
|
|
return $this->permissions_check( $request );
|
|
}
|
|
|
|
/**
|
|
* Gets an individual widget.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
|
|
*/
|
|
public function get_item( $request ) {
|
|
retrieve_widgets();
|
|
|
|
$widget_id = $request['id'];
|
|
$sidebar_id = wp_find_widgets_sidebar( $widget_id );
|
|
|
|
if ( is_null( $sidebar_id ) ) {
|
|
return new WP_Error(
|
|
'rest_widget_not_found',
|
|
__( 'No widget was found with that id.' ),
|
|
array( 'status' => 404 )
|
|
);
|
|
}
|
|
|
|
return $this->prepare_item_for_response( compact( 'widget_id', 'sidebar_id' ), $request );
|
|
}
|
|
|
|
/**
|
|
* Checks if a given request has access to create widgets.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return true|WP_Error True if the request has read access, WP_Error object otherwise.
|
|
*/
|
|
public function create_item_permissions_check( $request ) {
|
|
return $this->permissions_check( $request );
|
|
}
|
|
|
|
/**
|
|
* Creates a widget.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
|
|
*/
|
|
public function create_item( $request ) {
|
|
$sidebar_id = $request['sidebar'];
|
|
|
|
$widget_id = $this->save_widget( $request, $sidebar_id );
|
|
|
|
if ( is_wp_error( $widget_id ) ) {
|
|
return $widget_id;
|
|
}
|
|
|
|
wp_assign_widget_to_sidebar( $widget_id, $sidebar_id );
|
|
|
|
$request['context'] = 'edit';
|
|
|
|
$response = $this->prepare_item_for_response( compact( 'sidebar_id', 'widget_id' ), $request );
|
|
|
|
if ( is_wp_error( $response ) ) {
|
|
return $response;
|
|
}
|
|
|
|
$response->set_status( 201 );
|
|
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Checks if a given request has access to update widgets.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return true|WP_Error True if the request has read access, WP_Error object otherwise.
|
|
*/
|
|
public function update_item_permissions_check( $request ) {
|
|
return $this->permissions_check( $request );
|
|
}
|
|
|
|
/**
|
|
* Updates an existing widget.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @global WP_Widget_Factory $wp_widget_factory
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
|
|
*/
|
|
public function update_item( $request ) {
|
|
global $wp_widget_factory;
|
|
|
|
/*
|
|
* retrieve_widgets() contains logic to move "hidden" or "lost" widgets to the
|
|
* wp_inactive_widgets sidebar based on the contents of the $sidebars_widgets global.
|
|
*
|
|
* When batch requests are processed, this global is not properly updated by previous
|
|
* calls, resulting in widgets incorrectly being moved to the wp_inactive_widgets
|
|
* sidebar.
|
|
*
|
|
* See https://core.trac.wordpress.org/ticket/53657.
|
|
*/
|
|
wp_get_sidebars_widgets();
|
|
|
|
retrieve_widgets();
|
|
|
|
$widget_id = $request['id'];
|
|
$sidebar_id = wp_find_widgets_sidebar( $widget_id );
|
|
|
|
// Allow sidebar to be unset or missing when widget is not a WP_Widget.
|
|
$parsed_id = wp_parse_widget_id( $widget_id );
|
|
$widget_object = $wp_widget_factory->get_widget_object( $parsed_id['id_base'] );
|
|
if ( is_null( $sidebar_id ) && $widget_object ) {
|
|
return new WP_Error(
|
|
'rest_widget_not_found',
|
|
__( 'No widget was found with that id.' ),
|
|
array( 'status' => 404 )
|
|
);
|
|
}
|
|
|
|
if (
|
|
$request->has_param( 'instance' ) ||
|
|
$request->has_param( 'form_data' )
|
|
) {
|
|
$maybe_error = $this->save_widget( $request, $sidebar_id );
|
|
if ( is_wp_error( $maybe_error ) ) {
|
|
return $maybe_error;
|
|
}
|
|
}
|
|
|
|
if ( $request->has_param( 'sidebar' ) ) {
|
|
if ( $sidebar_id !== $request['sidebar'] ) {
|
|
$sidebar_id = $request['sidebar'];
|
|
wp_assign_widget_to_sidebar( $widget_id, $sidebar_id );
|
|
}
|
|
}
|
|
|
|
$request['context'] = 'edit';
|
|
|
|
return $this->prepare_item_for_response( compact( 'widget_id', 'sidebar_id' ), $request );
|
|
}
|
|
|
|
/**
|
|
* Checks if a given request has access to delete widgets.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return true|WP_Error True if the request has read access, WP_Error object otherwise.
|
|
*/
|
|
public function delete_item_permissions_check( $request ) {
|
|
return $this->permissions_check( $request );
|
|
}
|
|
|
|
/**
|
|
* Deletes a widget.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @global WP_Widget_Factory $wp_widget_factory
|
|
* @global array $wp_registered_widget_updates The registered widget update functions.
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
|
|
*/
|
|
public function delete_item( $request ) {
|
|
global $wp_widget_factory, $wp_registered_widget_updates;
|
|
|
|
/*
|
|
* retrieve_widgets() contains logic to move "hidden" or "lost" widgets to the
|
|
* wp_inactive_widgets sidebar based on the contents of the $sidebars_widgets global.
|
|
*
|
|
* When batch requests are processed, this global is not properly updated by previous
|
|
* calls, resulting in widgets incorrectly being moved to the wp_inactive_widgets
|
|
* sidebar.
|
|
*
|
|
* See https://core.trac.wordpress.org/ticket/53657.
|
|
*/
|
|
wp_get_sidebars_widgets();
|
|
|
|
retrieve_widgets();
|
|
|
|
$widget_id = $request['id'];
|
|
$sidebar_id = wp_find_widgets_sidebar( $widget_id );
|
|
|
|
if ( is_null( $sidebar_id ) ) {
|
|
return new WP_Error(
|
|
'rest_widget_not_found',
|
|
__( 'No widget was found with that id.' ),
|
|
array( 'status' => 404 )
|
|
);
|
|
}
|
|
|
|
$request['context'] = 'edit';
|
|
|
|
if ( $request['force'] ) {
|
|
$response = $this->prepare_item_for_response( compact( 'widget_id', 'sidebar_id' ), $request );
|
|
|
|
$parsed_id = wp_parse_widget_id( $widget_id );
|
|
$id_base = $parsed_id['id_base'];
|
|
|
|
$original_post = $_POST;
|
|
$original_request = $_REQUEST;
|
|
|
|
$_POST = array(
|
|
'sidebar' => $sidebar_id,
|
|
"widget-$id_base" => array(),
|
|
'the-widget-id' => $widget_id,
|
|
'delete_widget' => '1',
|
|
);
|
|
$_REQUEST = $_POST;
|
|
|
|
/** This action is documented in wp-admin/widgets-form.php */
|
|
do_action( 'delete_widget', $widget_id, $sidebar_id, $id_base );
|
|
|
|
$callback = $wp_registered_widget_updates[ $id_base ]['callback'];
|
|
$params = $wp_registered_widget_updates[ $id_base ]['params'];
|
|
|
|
if ( is_callable( $callback ) ) {
|
|
ob_start();
|
|
call_user_func_array( $callback, $params );
|
|
ob_end_clean();
|
|
}
|
|
|
|
$_POST = $original_post;
|
|
$_REQUEST = $original_request;
|
|
|
|
$widget_object = $wp_widget_factory->get_widget_object( $id_base );
|
|
|
|
if ( $widget_object ) {
|
|
/*
|
|
* WP_Widget sets `updated = true` after an update to prevent more than one widget
|
|
* from being saved per request. This isn't what we want in the REST API, though,
|
|
* as we support batch requests.
|
|
*/
|
|
$widget_object->updated = false;
|
|
}
|
|
|
|
wp_assign_widget_to_sidebar( $widget_id, '' );
|
|
|
|
$response->set_data(
|
|
array(
|
|
'deleted' => true,
|
|
'previous' => $response->get_data(),
|
|
)
|
|
);
|
|
} else {
|
|
wp_assign_widget_to_sidebar( $widget_id, 'wp_inactive_widgets' );
|
|
|
|
$response = $this->prepare_item_for_response(
|
|
array(
|
|
'sidebar_id' => 'wp_inactive_widgets',
|
|
'widget_id' => $widget_id,
|
|
),
|
|
$request
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Fires after a widget is deleted via the REST API.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param string $widget_id ID of the widget marked for deletion.
|
|
* @param string $sidebar_id ID of the sidebar the widget was deleted from.
|
|
* @param WP_REST_Response $response The response data.
|
|
* @param WP_REST_Request $request The request sent to the API.
|
|
*/
|
|
do_action( 'rest_delete_widget', $widget_id, $sidebar_id, $response, $request );
|
|
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Performs a permissions check for managing widgets.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @return true|WP_Error
|
|
*/
|
|
protected function permissions_check( $request ) {
|
|
if ( ! current_user_can( 'edit_theme_options' ) ) {
|
|
return new WP_Error(
|
|
'rest_cannot_manage_widgets',
|
|
__( 'Sorry, you are not allowed to manage widgets on this site.' ),
|
|
array(
|
|
'status' => rest_authorization_required_code(),
|
|
)
|
|
);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Saves the widget in the request object.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @global WP_Widget_Factory $wp_widget_factory
|
|
* @global array $wp_registered_widget_updates The registered widget update functions.
|
|
*
|
|
* @param WP_REST_Request $request Full details about the request.
|
|
* @param string $sidebar_id ID of the sidebar the widget belongs to.
|
|
* @return string|WP_Error The saved widget ID.
|
|
*/
|
|
protected function save_widget( $request, $sidebar_id ) {
|
|
global $wp_widget_factory, $wp_registered_widget_updates;
|
|
|
|
require_once ABSPATH . 'wp-admin/includes/widgets.php'; // For next_widget_id_number().
|
|
|
|
if ( isset( $request['id'] ) ) {
|
|
// Saving an existing widget.
|
|
$id = $request['id'];
|
|
$parsed_id = wp_parse_widget_id( $id );
|
|
$id_base = $parsed_id['id_base'];
|
|
$number = isset( $parsed_id['number'] ) ? $parsed_id['number'] : null;
|
|
$widget_object = $wp_widget_factory->get_widget_object( $id_base );
|
|
$creating = false;
|
|
} elseif ( $request['id_base'] ) {
|
|
// Saving a new widget.
|
|
$id_base = $request['id_base'];
|
|
$widget_object = $wp_widget_factory->get_widget_object( $id_base );
|
|
$number = $widget_object ? next_widget_id_number( $id_base ) : null;
|
|
$id = $widget_object ? $id_base . '-' . $number : $id_base;
|
|
$creating = true;
|
|
} else {
|
|
return new WP_Error(
|
|
'rest_invalid_widget',
|
|
__( 'Widget type (id_base) is required.' ),
|
|
array( 'status' => 400 )
|
|
);
|
|
}
|
|
|
|
if ( ! isset( $wp_registered_widget_updates[ $id_base ] ) ) {
|
|
return new WP_Error(
|
|
'rest_invalid_widget',
|
|
__( 'The provided widget type (id_base) cannot be updated.' ),
|
|
array( 'status' => 400 )
|
|
);
|
|
}
|
|
|
|
if ( isset( $request['instance'] ) ) {
|
|
if ( ! $widget_object ) {
|
|
return new WP_Error(
|
|
'rest_invalid_widget',
|
|
__( 'Cannot set instance on a widget that does not extend WP_Widget.' ),
|
|
array( 'status' => 400 )
|
|
);
|
|
}
|
|
|
|
if ( isset( $request['instance']['raw'] ) ) {
|
|
if ( empty( $widget_object->widget_options['show_instance_in_rest'] ) ) {
|
|
return new WP_Error(
|
|
'rest_invalid_widget',
|
|
__( 'Widget type does not support raw instances.' ),
|
|
array( 'status' => 400 )
|
|
);
|
|
}
|
|
$instance = $request['instance']['raw'];
|
|
} elseif ( isset( $request['instance']['encoded'], $request['instance']['hash'] ) ) {
|
|
$serialized_instance = base64_decode( $request['instance']['encoded'] );
|
|
if ( ! hash_equals( wp_hash( $serialized_instance ), $request['instance']['hash'] ) ) {
|
|
return new WP_Error(
|
|
'rest_invalid_widget',
|
|
__( 'The provided instance is malformed.' ),
|
|
array( 'status' => 400 )
|
|
);
|
|
}
|
|
$instance = unserialize( $serialized_instance );
|
|
} else {
|
|
return new WP_Error(
|
|
'rest_invalid_widget',
|
|
__( 'The provided instance is invalid. Must contain raw OR encoded and hash.' ),
|
|
array( 'status' => 400 )
|
|
);
|
|
}
|
|
|
|
$form_data = array(
|
|
"widget-$id_base" => array(
|
|
$number => $instance,
|
|
),
|
|
'sidebar' => $sidebar_id,
|
|
);
|
|
} elseif ( isset( $request['form_data'] ) ) {
|
|
$form_data = $request['form_data'];
|
|
} else {
|
|
$form_data = array();
|
|
}
|
|
|
|
$original_post = $_POST;
|
|
$original_request = $_REQUEST;
|
|
|
|
foreach ( $form_data as $key => $value ) {
|
|
$slashed_value = wp_slash( $value );
|
|
$_POST[ $key ] = $slashed_value;
|
|
$_REQUEST[ $key ] = $slashed_value;
|
|
}
|
|
|
|
$callback = $wp_registered_widget_updates[ $id_base ]['callback'];
|
|
$params = $wp_registered_widget_updates[ $id_base ]['params'];
|
|
|
|
if ( is_callable( $callback ) ) {
|
|
ob_start();
|
|
call_user_func_array( $callback, $params );
|
|
ob_end_clean();
|
|
}
|
|
|
|
$_POST = $original_post;
|
|
$_REQUEST = $original_request;
|
|
|
|
if ( $widget_object ) {
|
|
// Register any multi-widget that the update callback just created.
|
|
$widget_object->_set( $number );
|
|
$widget_object->_register_one( $number );
|
|
|
|
/*
|
|
* WP_Widget sets `updated = true` after an update to prevent more than one widget
|
|
* from being saved per request. This isn't what we want in the REST API, though,
|
|
* as we support batch requests.
|
|
*/
|
|
$widget_object->updated = false;
|
|
}
|
|
|
|
/**
|
|
* Fires after a widget is created or updated via the REST API.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param string $id ID of the widget being saved.
|
|
* @param string $sidebar_id ID of the sidebar containing the widget being saved.
|
|
* @param WP_REST_Request $request Request object.
|
|
* @param bool $creating True when creating a widget, false when updating.
|
|
*/
|
|
do_action( 'rest_after_save_widget', $id, $sidebar_id, $request, $creating );
|
|
|
|
return $id;
|
|
}
|
|
|
|
/**
|
|
* Prepares the widget for the REST response.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @global WP_Widget_Factory $wp_widget_factory
|
|
* @global array $wp_registered_widgets The registered widgets.
|
|
*
|
|
* @param array $item An array containing a widget_id and sidebar_id.
|
|
* @param WP_REST_Request $request Request object.
|
|
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
|
|
*/
|
|
public function prepare_item_for_response( $item, $request ) {
|
|
global $wp_widget_factory, $wp_registered_widgets;
|
|
|
|
$widget_id = $item['widget_id'];
|
|
$sidebar_id = $item['sidebar_id'];
|
|
|
|
if ( ! isset( $wp_registered_widgets[ $widget_id ] ) ) {
|
|
return new WP_Error(
|
|
'rest_invalid_widget',
|
|
__( 'The requested widget is invalid.' ),
|
|
array( 'status' => 500 )
|
|
);
|
|
}
|
|
|
|
$widget = $wp_registered_widgets[ $widget_id ];
|
|
$parsed_id = wp_parse_widget_id( $widget_id );
|
|
$fields = $this->get_fields_for_response( $request );
|
|
|
|
$prepared = array(
|
|
'id' => $widget_id,
|
|
'id_base' => $parsed_id['id_base'],
|
|
'sidebar' => $sidebar_id,
|
|
'rendered' => '',
|
|
'rendered_form' => null,
|
|
'instance' => null,
|
|
);
|
|
|
|
if (
|
|
rest_is_field_included( 'rendered', $fields ) &&
|
|
'wp_inactive_widgets' !== $sidebar_id
|
|
) {
|
|
$prepared['rendered'] = trim( wp_render_widget( $widget_id, $sidebar_id ) );
|
|
}
|
|
|
|
if ( rest_is_field_included( 'rendered_form', $fields ) ) {
|
|
$rendered_form = wp_render_widget_control( $widget_id );
|
|
if ( ! is_null( $rendered_form ) ) {
|
|
$prepared['rendered_form'] = trim( $rendered_form );
|
|
}
|
|
}
|
|
|
|
if ( rest_is_field_included( 'instance', $fields ) ) {
|
|
$widget_object = $wp_widget_factory->get_widget_object( $parsed_id['id_base'] );
|
|
if ( $widget_object && isset( $parsed_id['number'] ) ) {
|
|
$all_instances = $widget_object->get_settings();
|
|
$instance = $all_instances[ $parsed_id['number'] ];
|
|
$serialized_instance = serialize( $instance );
|
|
$prepared['instance']['encoded'] = base64_encode( $serialized_instance );
|
|
$prepared['instance']['hash'] = wp_hash( $serialized_instance );
|
|
|
|
if ( ! empty( $widget_object->widget_options['show_instance_in_rest'] ) ) {
|
|
// Use new stdClass so that JSON result is {} and not [].
|
|
$prepared['instance']['raw'] = empty( $instance ) ? new stdClass : $instance;
|
|
}
|
|
}
|
|
}
|
|
|
|
$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
|
|
$prepared = $this->add_additional_fields_to_object( $prepared, $request );
|
|
$prepared = $this->filter_response_by_context( $prepared, $context );
|
|
|
|
$response = rest_ensure_response( $prepared );
|
|
|
|
$response->add_links( $this->prepare_links( $prepared ) );
|
|
|
|
/**
|
|
* Filters the REST API response for a widget.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param WP_REST_Response $response The response object.
|
|
* @param array $widget The registered widget data.
|
|
* @param WP_REST_Request $request Request used to generate the response.
|
|
*/
|
|
return apply_filters( 'rest_prepare_widget', $response, $widget, $request );
|
|
}
|
|
|
|
/**
|
|
* Prepares links for the widget.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param array $prepared Widget.
|
|
* @return array Links for the given widget.
|
|
*/
|
|
protected function prepare_links( $prepared ) {
|
|
$id_base = ! empty( $prepared['id_base'] ) ? $prepared['id_base'] : $prepared['id'];
|
|
|
|
return array(
|
|
'self' => array(
|
|
'href' => rest_url( sprintf( '%s/%s/%s', $this->namespace, $this->rest_base, $prepared['id'] ) ),
|
|
),
|
|
'collection' => array(
|
|
'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),
|
|
),
|
|
'about' => array(
|
|
'href' => rest_url( sprintf( 'wp/v2/widget-types/%s', $id_base ) ),
|
|
'embeddable' => true,
|
|
),
|
|
'https://api.w.org/sidebar' => array(
|
|
'href' => rest_url( sprintf( 'wp/v2/sidebars/%s/', $prepared['sidebar'] ) ),
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Gets the list of collection params.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @return array[]
|
|
*/
|
|
public function get_collection_params() {
|
|
return array(
|
|
'context' => $this->get_context_param( array( 'default' => 'view' ) ),
|
|
'sidebar' => array(
|
|
'description' => __( 'The sidebar to return widgets for.' ),
|
|
'type' => 'string',
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Retrieves the widget's schema, conforming to JSON Schema.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @return array Item schema data.
|
|
*/
|
|
public function get_item_schema() {
|
|
if ( $this->schema ) {
|
|
return $this->add_additional_fields_schema( $this->schema );
|
|
}
|
|
|
|
$this->schema = array(
|
|
'$schema' => 'http://json-schema.org/draft-04/schema#',
|
|
'title' => 'widget',
|
|
'type' => 'object',
|
|
'properties' => array(
|
|
'id' => array(
|
|
'description' => __( 'Unique identifier for the widget.' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit', 'embed' ),
|
|
),
|
|
'id_base' => array(
|
|
'description' => __( 'The type of the widget. Corresponds to ID in widget-types endpoint.' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit', 'embed' ),
|
|
),
|
|
'sidebar' => array(
|
|
'description' => __( 'The sidebar the widget belongs to.' ),
|
|
'type' => 'string',
|
|
'default' => 'wp_inactive_widgets',
|
|
'required' => true,
|
|
'context' => array( 'view', 'edit', 'embed' ),
|
|
),
|
|
'rendered' => array(
|
|
'description' => __( 'HTML representation of the widget.' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit', 'embed' ),
|
|
'readonly' => true,
|
|
),
|
|
'rendered_form' => array(
|
|
'description' => __( 'HTML representation of the widget admin form.' ),
|
|
'type' => 'string',
|
|
'context' => array( 'edit' ),
|
|
'readonly' => true,
|
|
),
|
|
'instance' => array(
|
|
'description' => __( 'Instance settings of the widget, if supported.' ),
|
|
'type' => 'object',
|
|
'context' => array( 'view', 'edit', 'embed' ),
|
|
'default' => null,
|
|
'properties' => array(
|
|
'encoded' => array(
|
|
'description' => __( 'Base64 encoded representation of the instance settings.' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit', 'embed' ),
|
|
),
|
|
'hash' => array(
|
|
'description' => __( 'Cryptographic hash of the instance settings.' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit', 'embed' ),
|
|
),
|
|
'raw' => array(
|
|
'description' => __( 'Unencoded instance settings, if supported.' ),
|
|
'type' => 'object',
|
|
'context' => array( 'view', 'edit', 'embed' ),
|
|
),
|
|
),
|
|
),
|
|
'form_data' => array(
|
|
'description' => __( 'URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.' ),
|
|
'type' => 'string',
|
|
'context' => array(),
|
|
'arg_options' => array(
|
|
'sanitize_callback' => static function( $string ) {
|
|
$array = array();
|
|
wp_parse_str( $string, $array );
|
|
return $array;
|
|
},
|
|
),
|
|
),
|
|
),
|
|
);
|
|
|
|
return $this->add_additional_fields_schema( $this->schema );
|
|
}
|
|
}
|