PHPXRef 0.7.1 : WordPress : Detail view of class-wp-rest-themes-controller.php

Class: WP_REST_Themes_Controller - X-Ref

Core class used to manage themes via the REST API.

Constructor.

since: 5.0.0

Registers the routes for themes.

since: 5.0.0

_sanitize_stylesheet_callback( $stylesheet ) X-Ref

Sanitize the stylesheet to decode endpoint.

since: 5.9.0
return: string Sanitized stylesheet.
param: string $stylesheet The stylesheet name.

get_items_permissions_check( $request ) X-Ref

Checks if a given request has access to read the theme.

since: 5.0.0
return: true|WP_Error True if the request has read access for the item, otherwise WP_Error object.
param: WP_REST_Request $request Full details about the request.

get_item_permissions_check( $request ) X-Ref

Checks if a given request has access to read the theme.

since: 5.7.0
return: bool|WP_Error True if the request has read access for the item, otherwise WP_Error object.
param: WP_REST_Request $request Full details about the request.

check_read_active_theme_permission() X-Ref

Checks if a theme can be read.

since: 5.7.0
return: bool|WP_Error Whether the theme can be read.

get_item( $request ) X-Ref

Retrieves a single theme.

since: 5.7.0
return: WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
param: WP_REST_Request $request Full details about the request.

get_items( $request ) X-Ref

Retrieves a collection of themes.

since: 5.0.0
return: WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
param: WP_REST_Request $request Full details about the request.

prepare_item_for_response( $item, $request ) X-Ref

Prepares a single theme output for response.

since: 5.0.0
since: 5.9.0 Renamed `$theme` to `$item` to match parent class for PHP 8 named parameter support.
return: WP_REST_Response Response object.
param: WP_Theme $item Theme object.
param: WP_REST_Request $request Request object.

prepare_links( $theme ) X-Ref

Prepares links for the request.

since: 5.7.0
return: array Links for the given block type.
param: WP_Theme $theme Theme data.

is_same_theme( $theme_a, $theme_b ) X-Ref

Helper function to compare two themes.

since: 5.7.0
return: bool
param: WP_Theme $theme_a First theme to compare.
param: WP_Theme $theme_b Second theme to compare.

prepare_theme_support( $support, $args, $feature, $request ) X-Ref

Prepares the theme support value for inclusion in the REST API response.

since: 5.5.0
return: mixed The prepared support value.
param: mixed           $support The raw value from get_theme_support().
param: array           $args    The feature's registration args.
param: string          $feature The feature name.
param: WP_REST_Request $request The request object.

get_item_schema() X-Ref

Retrieves the theme's schema, conforming to JSON Schema.

since: 5.0.0
return: array Item schema data.

get_collection_params() X-Ref

Retrieves the search params for the themes collection.

since: 5.0.0
return: array Collection parameters.

sanitize_theme_status( $statuses, $request, $parameter ) X-Ref

Sanitizes and validates the list of theme status.

since: 5.0.0
return: array|WP_Error A list of valid statuses, otherwise WP_Error object.
param: string|array    $statuses  One or more theme statuses.
param: WP_REST_Request $request   Full details about the request.
param: string          $parameter Additional parameter to pass to validation.

File Size:	654 lines (19 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of WordPress

/wp-includes/rest-api/endpoints/ -> class-wp-rest-themes-controller.php (summary)

Defines 1 class