| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
REST API: WP_REST_Menu_Locations_Controller class
| File Size: | 301 lines (8 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
WP_REST_Menu_Locations_Controller:: (10 methods):
__construct()
register_routes()
get_items_permissions_check()
get_items()
get_item_permissions_check()
get_item()
prepare_item_for_response()
get_item_schema()
get_collection_params()
prepare_links()
Class: WP_REST_Menu_Locations_Controller - X-Ref
Core class used to access menu locations via the REST API.| __construct() X-Ref |
| Menu Locations 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 menu locations. 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 menu locations, 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 menu location. 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 |
| get_item( $request ) X-Ref |
| Retrieves a specific menu location. 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 |
| prepare_item_for_response( $item, $request ) X-Ref |
| Prepares a menu location object for serialization. return: WP_REST_Response Menu location data. param: stdClass $item Post status data. param: WP_REST_Request $request Full details about the request. since: 5.9.0 |
| get_item_schema() X-Ref |
| Retrieves the menu location'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 |
| prepare_links( $location ) X-Ref |
| Prepares links for the request. return: array Links for the given menu location. param: stdClass $location Menu location. since: 5.9.0 |
| Generated: Sat Nov 23 01:00:02 2024 | Cross-referenced by PHPXref 0.7.1 |