[ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
REST API: WP_REST_Block_Navigation_Areas_Controller class
File Size: | 310 lines (9 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
WP_REST_Block_Navigation_Areas_Controller:: (12 methods):
__construct()
register_routes()
get_items_permissions_check()
get_items()
get_item_permissions_check()
update_item_permissions_check()
get_item()
update_item()
get_navigation_area_object()
prepare_item_for_response()
get_item_schema()
get_collection_params()
Class: WP_REST_Block_Navigation_Areas_Controller - X-Ref
Core class used to access block navigation areas via the REST API.__construct() X-Ref |
Constructor. since: 5.9.0 |
register_routes() X-Ref |
Registers the routes for the objects of the controller. since: 5.9.0 |
get_items_permissions_check( $request ) X-Ref |
Checks whether a given request has permission to read navigation areas. return: WP_Error|bool True if the request has read access, WP_Error object otherwise. param: WP_REST_Request $request Full details about the request. since: 5.9.0 |
get_items( $request ) X-Ref |
Retrieves all navigation areas, depending on user context. return: WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure. param: WP_REST_Request $request Full details about the request. since: 5.9.0 |
get_item_permissions_check( $request ) X-Ref |
Checks if a given request has access to read a navigation area. return: WP_Error|bool True if the request has read access for the item, WP_Error object otherwise. param: WP_REST_Request $request Full details about the request. since: 5.9.0 |
update_item_permissions_check( $request ) X-Ref |
Checks if a request has access to update the specified term. return: bool|WP_Error True if the request has access to update the item, false or WP_Error object otherwise. param: WP_REST_Request $request Full details about the request. since: 5.9.0 |
get_item( $request ) X-Ref |
Retrieves a specific navigation area. return: WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure. param: WP_REST_Request $request Full details about the request. since: 5.9.0 |
update_item( $request ) X-Ref |
Updates a specific navigation area. return: WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure. param: WP_REST_Request $request Full details about the request. since: 5.9.0 |
get_navigation_area_object( $name ) X-Ref |
Converts navigation area name to a convenient object that this endpoint can reason about. return: stdClass An object representation of the navigation area. param: string $name Navigation area name. since: 5.9.0 |
prepare_item_for_response( $area, $request ) X-Ref |
Prepares a navigation area object for serialization. return: WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. param: stdClass $area Post status data. param: WP_REST_Request $request Full details about the request. since: 5.9.0 |
get_item_schema() X-Ref |
Retrieves the navigation area's schema, conforming to JSON Schema. return: array Item schema data. since: 5.9.0 |
get_collection_params() X-Ref |
Retrieves the query params for collections. return: array Collection parameters. since: 5.9.0 |
Generated: Mon Nov 29 01:00:03 2021 | Cross-referenced by PHPXref 0.7.1 |