WP_REST_Themes_Controller
- Since
- 5.0.0
- Source
wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php:17
Core class used to manage themes via the REST API.
Compatibility
- WordPress
- since 5.0.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0).
Hooks and filters fired · 2
Every hook that fires from inside WP_REST_Themes_Controller, in the order it appears in the class, grouped by the method that fires it.
Methods · 15
- __construct()Constructor.
- register_routes()Registers the routes for themes.
- _sanitize_stylesheet_callback()Sanitize the stylesheet to decode endpoint.
- get_items_permissions_check()Checks if a given request has access to read the theme.
- get_item_permissions_check()Checks if a given request has access to read the theme.
- check_read_active_theme_permission()Checks if a theme can be read.
- get_item()Retrieves a single theme.
- get_items()Retrieves a collection of themes.
- prepare_item_for_response()Prepares a single theme output for response.
- prepare_links()Prepares links for the request.
- is_same_theme()Helper function to compare two themes.
- prepare_theme_support()Prepares the theme support value for inclusion in the REST API response.
- get_item_schema()Retrieves the theme's schema, conforming to JSON Schema.
- get_collection_params()Retrieves the search params for the themes collection.
- sanitize_theme_status()Sanitizes and validates the list of theme status.
Source code
class WP_REST_Themes_Controller extends WP_REST_Controller { /** * Matches theme's directory: `/themes/<subdirectory>/<theme>/` or `/themes/<theme>/`. * Excludes invalid directory name characters: `/:<>*?"|`. */ const PATTERN = '[^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?'; /** * Constructor. * * @since 5.0.0 */ public function __construct() { $this->namespace = 'wp/v2'; $this->rest_base = 'themes'; } /** * Registers the routes for themes. * * @since 5.0.0 * * @see register_rest_route() */ 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(), ), 'schema' => array( $this, 'get_item_schema' ), ) ); register_rest_route( $this->namespace, sprintf( '/%s/(?P<stylesheet>%s)', $this->rest_base, self::PATTERN ), array( 'args' => array( 'stylesheet' => array( 'description' => __( "The theme's stylesheet. This uniquely identifies the theme." ), 'type' => 'string', 'sanitize_callback' => array( $this, '_sanitize_stylesheet_callback' ), ), ), array( 'methods' => WP_REST_Server::READABLE, 'callback' => array( $this, 'get_item' ), 'permission_callback' => array( $this, 'get_item_permissions_check' ), ), 'schema' => array( $this, 'get_public_item_schema' ), ) ); } /** * Sanitize the stylesheet to decode endpoint. * * @since 5.9.0 * * @param string $stylesheet The stylesheet name. * @return string Sanitized stylesheet. */ public function _sanitize_stylesheet_callback( $stylesheet ) { return urldecode( $stylesheet ); } /** * Checks if a given request has access to read the theme. * * @since 5.0.0 * * @param WP_REST_Request $request Full details about the request. * @return true|WP_Error True if the request has read access for the item, otherwise WP_Error object.Changelog
Introduced in 5.0.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 tag, from
src/wp-includes/rest-api/endpoints/class-wp-rest-themes-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.