• Accueil
  • WP_REST_Post_Types_Controller

PHP Class WP_REST_Post_Types_Controller, wordpress

Inheritance: extends WP_REST_Controller
Afficher le fichier Open project: johnpbloch/wordpress Class Usage Examples

Méthodes publiques

Méthode Description
__construct ( ) Constructor.
get_collection_params ( ) : array Retrieves the query params for collections.
get_item ( WP_REST_Request $request ) : WP_Error | WP_REST_Response Retrieves a specific post type.
get_item_schema ( ) : array Retrieves the post type's schema, conforming to JSON Schema.
get_items ( WP_REST_Request $request ) : WP_Error | WP_REST_Response Retrieves all public post types.
get_items_permissions_check ( WP_REST_Request $request ) : WP_Error | true Checks whether a given request has permission to read types.
prepare_item_for_response ( stdClass $post_type, WP_REST_Request $request ) : WP_REST_Response Prepares a post type object for serialization.
register_routes ( ) Registers the routes for the objects of the controller.

Method Details

__construct() public méthode

Constructor.
Since: 4.7.0
public __construct ( )

get_collection_params() public méthode

Retrieves the query params for collections.
Since: 4.7.0
public get_collection_params ( ) : array
Résultat array Collection parameters.

get_item() public méthode

Retrieves a specific post type.
Since: 4.7.0
public get_item ( WP_REST_Request $request ) : WP_Error | WP_REST_Response
$request WP_REST_Request Full details about the request.
Résultat WP_Error | WP_REST_Response Response object on success, or WP_Error object on failure.

get_item_schema() public méthode

Retrieves the post type's schema, conforming to JSON Schema.
Since: 4.7.0
public get_item_schema ( ) : array
Résultat array Item schema data.

get_items() public méthode

Retrieves all public post types.
Since: 4.7.0
public get_items ( WP_REST_Request $request ) : WP_Error | WP_REST_Response
$request WP_REST_Request Full details about the request.
Résultat WP_Error | WP_REST_Response Response object on success, or WP_Error object on failure.

get_items_permissions_check() public méthode

Checks whether a given request has permission to read types.
Since: 4.7.0
public get_items_permissions_check ( WP_REST_Request $request ) : WP_Error | true
$request WP_REST_Request Full details about the request.
Résultat WP_Error | true True if the request has read access, WP_Error object otherwise.

prepare_item_for_response() public méthode

Prepares a post type object for serialization.
Since: 4.7.0
public prepare_item_for_response ( stdClass $post_type, WP_REST_Request $request ) : WP_REST_Response
$post_type stdClass Post type data.
$request WP_REST_Request Full details about the request.
Résultat WP_REST_Response Response object.

register_routes() public méthode

Registers the routes for the objects of the controller.
See also: register_rest_route()
Since: 4.7.0
public register_routes ( )