| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
REST API: WP_REST_Post_Statuses_Controller class
| File Size: | 373 lines (10 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
WP_REST_Post_Statuses_Controller:: (10 methods):
__construct()
register_routes()
get_items_permissions_check()
get_items()
get_item_permissions_check()
check_read_permission()
get_item()
prepare_item_for_response()
get_item_schema()
get_collection_params()
Class: WP_REST_Post_Statuses_Controller - X-Ref
Core class used to access post statuses via the REST API.| __construct() X-Ref |
| Constructor. since: 4.7.0 |
| register_routes() X-Ref |
| Registers the routes for post statuses. since: 4.7.0 |
| get_items_permissions_check( $request ) X-Ref |
| Checks whether a given request has permission to read post statuses. return: true|WP_Error True if the request has read access, WP_Error object otherwise. param: WP_REST_Request $request Full details about the request. since: 4.7.0 |
| get_items( $request ) X-Ref |
| Retrieves all post statuses, depending on user context. return: WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. param: WP_REST_Request $request Full details about the request. since: 4.7.0 |
| get_item_permissions_check( $request ) X-Ref |
| Checks if a given request has access to read a post status. return: true|WP_Error 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: 4.7.0 |
| check_read_permission( $status ) X-Ref |
| Checks whether a given post status should be visible. return: bool True if the post status is visible, otherwise false. param: object $status Post status. since: 4.7.0 |
| get_item( $request ) X-Ref |
| Retrieves a specific post status. return: WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. param: WP_REST_Request $request Full details about the request. since: 4.7.0 |
| prepare_item_for_response( $item, $request ) X-Ref |
| Prepares a post status object for serialization. return: WP_REST_Response Post status data. param: stdClass $item Post status data. param: WP_REST_Request $request Full details about the request. since: 4.7.0 since: 5.9.0 Renamed `$status` to `$item` to match parent class for PHP 8 named parameter support. |
| get_item_schema() X-Ref |
| Retrieves the post status' schema, conforming to JSON Schema. return: array Item schema data. since: 4.7.0 |
| get_collection_params() X-Ref |
| Retrieves the query params for collections. return: array Collection parameters. since: 4.7.0 |
| Generated: Sat Nov 23 01:00:02 2024 | Cross-referenced by PHPXref 0.7.1 |