WP_REST_Global_Styles_Controller

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Properties · 1

$allow_batcharrayprotected

Whether the controller supports batching.

Methods · 18

• __construct()Constructor.
• register_routes()Registers the controllers routes.
• _sanitize_global_styles_callback()Sanitize the global styles stylesheet to decode endpoint.
• get_post()Get the post, if the ID is valid.
• get_item_permissions_check()Checks if a given request has access to read a single global style.
• check_read_permission()Checks if a global style can be read.
• update_item_permissions_check()Checks if a given request has access to write a single global styles config.
• prepare_item_for_database()Prepares a single global styles config for update.
• prepare_item_for_response()Prepare a global styles config output for response.
• prepare_links()Prepares links for the request.
• get_available_actions()Get the link relations available for the post and current user.
• get_collection_params()Retrieves the query params for the global styles collection.
• get_item_schema()Retrieves the global styles type' schema, conforming to JSON Schema.
• get_theme_item_permissions_check()Checks if a given request has access to read a single theme global styles config.
• get_theme_item()Returns the given theme global styles config.
• get_theme_items_permissions_check()Checks if a given request has access to read a single theme global styles config.
• get_theme_items()Returns the given theme global styles variations.
• validate_custom_css()Validate style.css as valid CSS.

Source code

View on Trac ↗View on GitHub ↗

13class WP_REST_Global_Styles_Controller extends WP_REST_Posts_Controller {14	/**15	 * Whether the controller supports batching.16	 *17	 * @since 6.6.018	 * @var array19	 */20	protected $allow_batch = array( 'v1' => false );21 22	/**23	 * Constructor.24	 *25	 * @since 6.6.026	 *27	 * @param string $post_type Post type.28	 */29	public function __construct( $post_type = 'wp_global_styles' ) {30		parent::__construct( $post_type );31	}32 33	/**34	 * Registers the controllers routes.35	 *36	 * @since 5.9.037	 */38	public function register_routes() {39		register_rest_route(40			$this->namespace,41			'/' . $this->rest_base . '/themes/(?P<stylesheet>[\/\s%\w\.\(\)\[\]\@_\-]+)/variations',42			array(43				array(44					'methods'             => WP_REST_Server::READABLE,45					'callback'            => array( $this, 'get_theme_items' ),46					'permission_callback' => array( $this, 'get_theme_items_permissions_check' ),47					'args'                => array(48						'stylesheet' => array(49							'description' => __( 'The theme identifier' ),50							'type'        => 'string',51						),52					),53					'allow_batch'         => $this->allow_batch,54				),55			)56		);57 58		// List themes global styles.59		register_rest_route(60			$this->namespace,61			// The route.62			sprintf(63				'/%s/themes/(?P<stylesheet>%s)',64				$this->rest_base,65				/*66				 * Matches theme's directory: `/themes/<subdirectory>/<theme>/` or `/themes/<theme>/`.67				 * Excludes invalid directory name characters: `/:<>*?"|`.68				 */69				'[^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?'70			),71			array(72				array(73					'methods'             => WP_REST_Server::READABLE,74					'callback'            => array( $this, 'get_theme_item' ),75					'permission_callback' => array( $this, 'get_theme_item_permissions_check' ),76					'args'                => array(77						'stylesheet' => array(78							'description'       => __( 'The theme identifier' ),79							'type'              => 'string',80							'sanitize_callback' => array( $this, '_sanitize_global_styles_callback' ),81						),82					),83					'allow_batch'         => $this->allow_batch,84				),85			)86		);87 88		// Lists/updates a single global style variation based on the given id.89		register_rest_route(90			$this->namespace,91			'/' . $this->rest_base . '/(?P<id>[\/\d+]+)',92			array(

Changelog

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-global-styles-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.