• Home
• WP_REST_Posts_Controller

PHP Class WP_REST_Posts_Controller, wordpress

Datei anzeigen Open project: johnpbloch/wordpress Class Usage Examples

Protected Properties

Property	Type	Description
$meta	WP_REST_Post_Meta_Fields	Instance of a post meta fields object.
$post_type	string	Post type.

Public Methods

Method	Description
__construct ( string $post_type )	Constructor.
can_access_password_content ( WP_Post $post, WP_REST_Request $request ) : boolean	Checks if the user can access password-protected content.
check_read_permission ( object $post ) : boolean	Checks if a post can be read.
create_item ( WP_REST_Request $request ) : WP_REST_Response | WP_Error	Creates a single post.
create_item_permissions_check ( WP_REST_Request $request ) : true | WP_Error	Checks if a given request has access to create a post.
delete_item ( WP_REST_Request $request ) : WP_REST_Response | WP_Error	Deletes a single post.
delete_item_permissions_check ( WP_REST_Request $request ) : true | WP_Error	Checks if a given request has access to delete a post.
get_collection_params ( ) : array	Retrieves the query params for the posts collection.
get_item ( WP_REST_Request $request ) : WP_REST_Response | WP_Error	Retrieves a single post.
get_item_permissions_check ( WP_REST_Request $request ) : boolean | WP_Error	Checks if a given request has access to read a post.
get_item_schema ( ) : array	Retrieves the post's schema, conforming to JSON Schema.
get_items ( WP_REST_Request $request ) : WP_REST_Response | WP_Error	Retrieves a collection of posts.
get_items_permissions_check ( WP_REST_Request $request ) : true | WP_Error	Checks if a given request has access to read posts.
handle_template ( string $template, integer $post_id )	Sets the template for a post.
prepare_item_for_response ( WP_Post $post, WP_REST_Request $request ) : WP_REST_Response	Prepares a single post output for response.
protected_title_format ( ) : string	Overwrites the default protected title format.
register_routes ( )	Registers the routes for the objects of the controller.
sanitize_post_statuses ( string | array $statuses, WP_REST_Request $request, string $parameter ) : array | WP_Error	Sanitizes and validates the list of post statuses, including whether the user can query private statuses.
update_item ( WP_REST_Request $request ) : WP_REST_Response | WP_Error	Updates a single post.
update_item_permissions_check ( WP_REST_Request $request ) : true | WP_Error	Checks if a given request has access to update a post.

Protected Methods

Method	Description
check_assign_terms_permission ( WP_REST_Request $request ) : boolean	Checks whether current user can assign all terms sent with the current request.
check_create_permission ( object $post ) : boolean	Checks if a post can be created.
check_delete_permission ( object $post ) : boolean	Checks if a post can be deleted.
check_is_post_type_allowed ( object | string $post_type ) : boolean	Checks if a given post type can be viewed or managed.
check_update_permission ( object $post ) : boolean	Checks if a post can be edited.
handle_featured_media ( integer $featured_media, integer $post_id ) : boolean | WP_Error	Determines the featured media based on a request param.
handle_status_param ( string $post_status, object $post_type ) : string | WP_Error	Determines validity and normalizes the given status parameter.
handle_terms ( integer $post_id, WP_REST_Request $request ) : null | WP_Error	Updates the post's terms from a REST request.
prepare_date_response ( string $date_gmt, string | null $date = null ) : string | null	Checks the post_date_gmt or modified_gmt and prepare any post or modified date for single post output.
prepare_item_for_database ( WP_REST_Request $request ) : stdClass | WP_Error	Prepares a single post for create or update.
prepare_items_query ( array $prepared_args = [], WP_REST_Request $request = null ) : array	Determines the allowed query_vars for a get_items() response and prepares them for WP_Query.
prepare_links ( WP_Post $post ) : array	Prepares links for the request.

Method Details

Property Details