PHP Class WC_REST_Posts_Controller

Author: WooThemes

Inheritance: extends WC_REST_Controller

Show file Open project: woocommerce/woocommerce Class Usage Examples

Protected Properties

Property	Type	Description
$namespace	string	Endpoint namespace.
$post_type	string	Post type.
$public	string	Controls visibility on frontend.
$rest_base	string	Route base.

Public Methods

Method	Description
batch_items_permissions_check ( WP_REST_Request $request ) : boolean	Check if a given request has access batch create, update and delete items.
create_item ( WP_REST_Request $request ) : WP_Error \| WP_REST_Response	Create a single item.
create_item_permissions_check ( WP_REST_Request $request ) : WP_Error \| boolean	Check if a given request has access to create an item.
delete_item ( WP_REST_Request $request ) : WP_REST_Response \| WP_Error	Delete a single item.
delete_item_permissions_check ( WP_REST_Request $request ) : boolean \| WP_Error	Check if a given request has access to delete an item.
get_collection_params ( ) : array	Get the query params for collections of attachments.
get_item ( WP_REST_Request $request ) : WP_Error \| WP_REST_Response	Get a single item.
get_item_permissions_check ( WP_REST_Request $request ) : WP_Error \| boolean	Check if a given request has access to read an item.
get_items ( WP_REST_Request $request ) : WP_Error \| WP_REST_Response	Get a collection of posts.
get_items_permissions_check ( WP_REST_Request $request ) : WP_Error \| boolean	Check if a given request has access to read items.
update_item ( WP_REST_Request $request ) : WP_Error \| WP_REST_Response	Update a single post.
update_item_permissions_check ( WP_REST_Request $request ) : WP_Error \| boolean	Check if a given request has access to update an item.

Protected Methods

Method	Description
add_post_meta_fields ( WP_Post $post, WP_REST_Request $request ) : boolean \| WP_Error	Add post meta fields.
delete_post ( WP_Post $post )	Delete post.
get_allowed_query_vars ( ) : array	Get all the WP Query vars that are allowed for the API request.
prepare_items_query ( array $prepared_args = [], WP_REST_Request $request = null ) : array	Determine the allowed query_vars for a get_items() response and prepare for WP_Query.
prepare_links ( WP_Post $post, WP_REST_Request $request ) : array	Prepare links for the request.
update_post_meta_fields ( WP_Post $post, WP_REST_Request $request ) : boolean \| WP_Error	Update post meta fields.

Method Details

add_post_meta_fields() protected method

Add post meta fields.

protected add_post_meta_fields ( WP_Post $post, WP_REST_Request $request ) : boolean \| WP_Error
$post	WP_Post
$request	WP_REST_Request
return	boolean \| WP_Error

batch_items_permissions_check() public method

Check if a given request has access batch create, update and delete items.

public batch_items_permissions_check ( WP_REST_Request $request ) : boolean
$request	WP_REST_Request	Full details about the request.
return	boolean

create_item() public method

Create a single item.

public create_item ( WP_REST_Request $request ) : WP_Error \| WP_REST_Response
$request	WP_REST_Request	Full details about the request.
return	WP_Error \| WP_REST_Response

create_item_permissions_check() public method

Check if a given request has access to create an item.

public create_item_permissions_check ( WP_REST_Request $request ) : WP_Error \| boolean
$request	WP_REST_Request	Full details about the request.
return	WP_Error \| boolean

delete_item() public method

Delete a single item.

public delete_item ( WP_REST_Request $request ) : WP_REST_Response \| WP_Error
$request	WP_REST_Request	Full details about the request.
return	WP_REST_Response \| WP_Error

delete_item_permissions_check() public method

Check if a given request has access to delete an item.

public delete_item_permissions_check ( WP_REST_Request $request ) : boolean \| WP_Error
$request	WP_REST_Request	Full details about the request.
return	boolean \| WP_Error

delete_post() protected method

Delete post.

protected delete_post ( WP_Post $post )
$post	WP_Post

get_allowed_query_vars() protected method

Get all the WP Query vars that are allowed for the API request.

protected get_allowed_query_vars ( ) : array
return	array

get_collection_params() public method

Get the query params for collections of attachments.

public get_collection_params ( ) : array
return	array

get_item() public method

Get a single item.

public get_item ( WP_REST_Request $request ) : WP_Error \| WP_REST_Response
$request	WP_REST_Request	Full details about the request.
return	WP_Error \| WP_REST_Response

get_item_permissions_check() public method

Check if a given request has access to read an item.

public get_item_permissions_check ( WP_REST_Request $request ) : WP_Error \| boolean
$request	WP_REST_Request	Full details about the request.
return	WP_Error \| boolean

get_items() public method

Get a collection of posts.

public get_items ( WP_REST_Request $request ) : WP_Error \| WP_REST_Response
$request	WP_REST_Request	Full details about the request.
return	WP_Error \| WP_REST_Response

get_items_permissions_check() public method

Check if a given request has access to read items.

public get_items_permissions_check ( WP_REST_Request $request ) : WP_Error \| boolean
$request	WP_REST_Request	Full details about the request.
return	WP_Error \| boolean

prepare_items_query() protected method

Determine the allowed query_vars for a get_items() response and prepare for WP_Query.

protected prepare_items_query ( array $prepared_args = [], WP_REST_Request $request = null ) : array
$prepared_args	array
$request	WP_REST_Request
return	array	$query_args

prepare_links() protected method

Prepare links for the request.

protected prepare_links ( WP_Post $post, WP_REST_Request $request ) : array
$post	WP_Post	Post object.
$request	WP_REST_Request	Request object.
return	array	Links for the given post.

update_item() public method

Update a single post.

public update_item ( WP_REST_Request $request ) : WP_Error \| WP_REST_Response
$request	WP_REST_Request	Full details about the request.
return	WP_Error \| WP_REST_Response

update_item_permissions_check() public method

Check if a given request has access to update an item.

public update_item_permissions_check ( WP_REST_Request $request ) : WP_Error \| boolean
$request	WP_REST_Request	Full details about the request.
return	WP_Error \| boolean

update_post_meta_fields() protected method

Update post meta fields.

protected update_post_meta_fields ( WP_Post $post, WP_REST_Request $request ) : boolean \| WP_Error
$post	WP_Post
$request	WP_REST_Request
return	boolean \| WP_Error

Property Details

$namespace protected property

Endpoint namespace.

protected string $namespace
return	string

$post_type protected property

Post type.

protected string $post_type
return	string

$public protected property

Controls visibility on frontend.

protected string $public
return	string

$rest_base protected property

Route base.

protected string $rest_base
return	string