[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/rest-api/endpoints/ -> class-wp-rest-post-types-controller.php (summary)

REST API: WP_REST_Post_Types_Controller class

File Size: 337 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

WP_REST_Post_Types_Controller:: (8 methods):
  __construct()
  register_routes()
  get_items_permissions_check()
  get_items()
  get_item()
  prepare_item_for_response()
  get_item_schema()
  get_collection_params()


Class: WP_REST_Post_Types_Controller  - X-Ref

Core class to access post types via the REST API.

__construct()   X-Ref
Constructor.

since: 4.7.0

register_routes()   X-Ref
Registers the routes for the objects of the controller.

since: 4.7.0

get_items_permissions_check( $request )   X-Ref
Checks whether a given request has permission to read types.

return: WP_Error|true 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 public post types.

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: 4.7.0

get_item( $request )   X-Ref
Retrieves a specific post type.

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: 4.7.0

prepare_item_for_response( $post_type, $request )   X-Ref
Prepares a post type object for serialization.

return: WP_REST_Response Response object.
param: WP_Post_Type    $post_type Post type object.
param: WP_REST_Request $request   Full details about the request.
since: 4.7.0

get_item_schema()   X-Ref
Retrieves the post type's 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: Thu Sep 19 01:00:03 2019 Cross-referenced by PHPXref 0.7.1