[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

REST API: WP_REST_Themes_Controller class

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

Defines 1 class

WP_REST_Themes_Controller:: (14 methods):
  __construct()
  register_routes()
  get_items_permissions_check()
  get_item_permissions_check()
  check_read_active_theme_permission()
  get_item()
  get_items()
  prepare_item_for_response()
  prepare_links()
  is_same_theme()
  prepare_theme_support()
  get_item_schema()
  get_collection_params()
  sanitize_theme_status()


Class: WP_REST_Themes_Controller  - X-Ref

Core class used to manage themes via the REST API.

__construct()   X-Ref
Constructor.

since: 5.0.0

register_routes()   X-Ref
Registers the routes for the objects of the controller.

since: 5.0.0

get_items_permissions_check( $request )   X-Ref
Checks if a given request has access to read the theme.

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

get_item_permissions_check( $request )   X-Ref
Checks if a given request has access to read the theme.

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

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.

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

get_items( $request )   X-Ref
Retrieves a collection of themes.

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

prepare_item_for_response( $theme, $request )   X-Ref
Prepares a single theme output for response.

param: WP_Theme        $theme   Theme object.
param: WP_REST_Request $request Request object.
since: 5.0.0
return: WP_REST_Response Response object.

prepare_links( $theme )   X-Ref
Prepares links for the request.

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

is_same_theme( $theme_a, $theme_b )   X-Ref
Helper function to compare two themes.

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

prepare_theme_support( $support, $args, $feature, $request )   X-Ref
Prepares the theme support value for inclusion in the REST API response.

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.
since: 5.5.0
return: mixed The prepared support value.

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.

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.
since: 5.0.0
return: array|WP_Error A list of valid statuses, otherwise WP_Error object.



Generated: Wed Apr 21 01:00:05 2021 Cross-referenced by PHPXref 0.7.1