WP_REST_Controller

Properties · 3

$namespacestringprotected

The namespace of this controller's route.

$rest_basestringprotected

The base of this controller's route.

$schemaarrayprotected

Cached results of get_item_schema.

Methods · 27

• register_routes()Registers the routes for the objects of the controller.
• get_items_permissions_check()Checks if a given request has access to get items.
• get_items()Retrieves a collection of items.
• get_item_permissions_check()Checks if a given request has access to get a specific item.
• get_item()Retrieves one item from the collection.
• create_item_permissions_check()Checks if a given request has access to create items.
• create_item()Creates one item from the collection.
• update_item_permissions_check()Checks if a given request has access to update a specific item.
• update_item()Updates one item from the collection.
• delete_item_permissions_check()Checks if a given request has access to delete a specific item.
• delete_item()Deletes one item from the collection.
• prepare_item_for_database()Prepares one item for create or update operation.
• prepare_item_for_response()Prepares the item for the REST response.
• prepare_response_for_collection()Prepares a response for insertion into a collection.
• filter_response_by_context()Filters a response based on the context defined in the schema.
• get_item_schema()Retrieves the item's schema, conforming to JSON Schema.
• get_public_item_schema()Retrieves the item's schema for display / public consumption purposes.
• get_collection_params()Retrieves the query params for the collections.
• get_context_param()Retrieves the magical context param.
• add_additional_fields_to_object()Adds the values from additional fields to a data object.
• update_additional_fields_for_object()Updates the values of additional fields added to a data object.
• add_additional_fields_schema()Adds the schema from additional fields to a schema array.
• get_additional_fields()Retrieves all of the registered additional fields for a given object-type.
• get_object_type()Retrieves the object type this controller is responsible for managing.
• get_fields_for_response()Gets an array of fields to be included on the response.
• get_endpoint_args_for_item_schema()Retrieves an array of endpoint arguments from the item schema for the controller.
• sanitize_slug()Sanitizes the slug value.

Source

View on Trac ↗View on GitHub ↗

15#[AllowDynamicProperties]16abstract class WP_REST_Controller {17 18	/**19	 * The namespace of this controller's route.20	 *21	 * @since 4.7.022	 * @var string23	 */24	protected $namespace;25 26	/**27	 * The base of this controller's route.28	 *29	 * @since 4.7.030	 * @var string31	 */32	protected $rest_base;33 34	/**35	 * Cached results of get_item_schema.36	 *37	 * @since 5.3.038	 * @var array39	 */40	protected $schema;41 42	/**43	 * Registers the routes for the objects of the controller.44	 *45	 * @since 4.7.046	 *47	 * @see register_rest_route()48	 */49	public function register_routes() {50		_doing_it_wrong(51			'WP_REST_Controller::register_routes',52			/* translators: %s: register_routes() */53			sprintf( __( "Method '%s' must be overridden." ), __METHOD__ ),54			'4.7.0'55		);56	}57 58	/**59	 * Checks if a given request has access to get items.60	 *61	 * @since 4.7.062	 *63	 * @param WP_REST_Request $request Full details about the request.64	 * @return true|WP_Error True if the request has read access, WP_Error object otherwise.65	 */66	public function get_items_permissions_check( $request ) {67		return new WP_Error(68			'invalid-method',69			/* translators: %s: Method name. */70			sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ),71			array( 'status' => 405 )72		);73	}74 75	/**76	 * Retrieves a collection of items.77	 *78	 * @since 4.7.079	 *80	 * @param WP_REST_Request $request Full details about the request.81	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.82	 */83	public function get_items( $request ) {84		return new WP_Error(85			'invalid-method',86			/* translators: %s: Method name. */87			sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ),88			array( 'status' => 405 )89		);90	}91 92	/**93	 * Checks if a given request has access to get a specific item.94	 *

History

Introduced in 4.7.0. 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.7.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-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.