wc_rest_check_post_permissions( string $post_type, string $context = 'read', int $object_id )

Check permissions of posts on REST API.

Contents

Description Description

Parameters Parameters

$post_type

(Required) Post type.

$context

(Optional) Request context.

Default value: 'read'

$object_id

(Required) Post ID.

Top ↑

Return Return

(bool)

Top ↑

Source Source

File: includes/wc-rest-functions.php 

function wc_rest_check_post_permissions( $post_type, $context = 'read', $object_id = 0 ) {
	$contexts = array(
		'read'   => 'read_private_posts',
		'create' => 'publish_posts',
		'edit'   => 'edit_post',
		'delete' => 'delete_post',
		'batch'  => 'edit_others_posts',
	);

	if ( 'revision' === $post_type ) {
		$permission = false;
	} else {
		$cap              = $contexts[ $context ];
		$post_type_object = get_post_type_object( $post_type );
		$permission       = current_user_can( $post_type_object->cap->$cap, $object_id );
	}

	return apply_filters( 'woocommerce_rest_check_permissions', $permission, $context, $object_id, $post_type );
}

Expand full source code Collapse full source code

Top ↑

Changelog Changelog

Changelog
Version Description
2.6.0 Introduced.

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
packages/woocommerce-admin/src/API/OnboardingTasks.php: OnboardingTasks::create_products_permission_check()

Check if a given request has access to create a product.
packages/woocommerce-admin/src/API/OnboardingTasks.php: OnboardingTasks::create_pages_permission_check()

Check if a given request has access to create a product.
includes/rest-api/Controllers/Version3/class-wc-rest-crud-controller.php: WC_REST_CRUD_Controller::get_items()

Get a collection of posts.
includes/rest-api/Controllers/Version3/class-wc-rest-crud-controller.php: WC_REST_CRUD_Controller::delete_item()

Delete a single item.
includes/rest-api/Controllers/Version3/class-wc-rest-crud-controller.php: WC_REST_CRUD_Controller::get_item_permissions_check()

Check if a given request has access to read an item.
includes/rest-api/Controllers/Version3/class-wc-rest-crud-controller.php: WC_REST_CRUD_Controller::update_item_permissions_check()

Check if a given request has access to update an item.
includes/rest-api/Controllers/Version3/class-wc-rest-crud-controller.php: WC_REST_CRUD_Controller::delete_item_permissions_check()

Check if a given request has access to delete an item.
includes/rest-api/Controllers/Version3/class-wc-rest-posts-controller.php: WC_REST_Posts_Controller::get_item_permissions_check()

Check if a given request has access to read an item.
includes/rest-api/Controllers/Version3/class-wc-rest-posts-controller.php: WC_REST_Posts_Controller::update_item_permissions_check()

Check if a given request has access to update an item.
includes/rest-api/Controllers/Version3/class-wc-rest-posts-controller.php: WC_REST_Posts_Controller::delete_item_permissions_check()

Check if a given request has access to delete an item.
includes/rest-api/Controllers/Version3/class-wc-rest-posts-controller.php: WC_REST_Posts_Controller::batch_items_permissions_check()

Check if a given request has access batch create, update and delete items.
includes/rest-api/Controllers/Version3/class-wc-rest-posts-controller.php: WC_REST_Posts_Controller::get_items()

Get a collection of posts.
includes/rest-api/Controllers/Version3/class-wc-rest-posts-controller.php: WC_REST_Posts_Controller::delete_item()

Delete a single item.
includes/rest-api/Controllers/Version3/class-wc-rest-posts-controller.php: WC_REST_Posts_Controller::get_items_permissions_check()

Check if a given request has access to read items.
includes/rest-api/Controllers/Version3/class-wc-rest-posts-controller.php: WC_REST_Posts_Controller::create_item_permissions_check()

Check if a given request has access to create an item.
includes/rest-api/Controllers/Version1/class-wc-rest-product-reviews-v1-controller.php: WC_REST_Product_Reviews_V1_Controller::get_items_permissions_check()

Check whether a given request has permission to read webhook deliveries.
includes/rest-api/Controllers/Version1/class-wc-rest-product-reviews-v1-controller.php: WC_REST_Product_Reviews_V1_Controller::get_item_permissions_check()

Check if a given request has access to read a product review.
includes/rest-api/Controllers/Version1/class-wc-rest-product-reviews-v1-controller.php: WC_REST_Product_Reviews_V1_Controller::create_item_permissions_check()

Check if a given request has access to create a new product review.
includes/rest-api/Controllers/Version1/class-wc-rest-product-reviews-v1-controller.php: WC_REST_Product_Reviews_V1_Controller::update_item_permissions_check()

Check if a given request has access to update a product review.
includes/rest-api/Controllers/Version1/class-wc-rest-product-reviews-v1-controller.php: WC_REST_Product_Reviews_V1_Controller::delete_item_permissions_check()

Check if a given request has access to delete a product review.
includes/rest-api/Controllers/Version1/class-wc-rest-order-notes-v1-controller.php: WC_REST_Order_Notes_V1_Controller::get_items_permissions_check()

Check whether a given request has permission to read order notes.
includes/rest-api/Controllers/Version1/class-wc-rest-order-notes-v1-controller.php: WC_REST_Order_Notes_V1_Controller::create_item_permissions_check()

Check if a given request has access create order notes.
includes/rest-api/Controllers/Version1/class-wc-rest-order-notes-v1-controller.php: WC_REST_Order_Notes_V1_Controller::get_item_permissions_check()

Check if a given request has access to read a order note.
includes/rest-api/Controllers/Version1/class-wc-rest-order-notes-v1-controller.php: WC_REST_Order_Notes_V1_Controller::delete_item_permissions_check()

Check if a given request has access delete a order note.
includes/rest-api/Controllers/Version1/class-wc-rest-products-v1-controller.php: WC_REST_Products_V1_Controller::delete_item()

Delete a single item.
includes/rest-api/Controllers/Version2/class-wc-rest-product-variations-v2-controller.php: WC_REST_Product_Variations_V2_Controller::delete_item()

Delete a variation.
includes/rest-api/Controllers/Version2/class-wc-rest-product-reviews-v2-controller.php: WC_REST_Product_Reviews_V2_Controller::batch_items_permissions_check()

Check if a given request has access to batch manage product reviews.
includes/rest-api/Controllers/Version2/class-wc-rest-product-variations-v2-controller.php: WC_REST_Product_Variations_V2_Controller::update_item_permissions_check()

Check if a given request has access to update an item.
includes/rest-api/Controllers/Version2/class-wc-rest-products-v2-controller.php: WC_REST_Products_V2_Controller::delete_item()

Delete a single item.
Show 24 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.