llms_rest_authorization_required_error( string $message = '', boolean $check_authenticated = true )

Return a WP_Error with proper code, message and status for unauthorized requests.

Contents

Parameters Parameters

$message

(string) (Optional) The custom error message. When no custom message is provided a predefined message will be used.

Default value: ''

$check_authenticated

(boolean) (Optional) Whether or not checking if the current user is logged in. Default true.

Default value: true

Top ↑

Return Return

(WP_Error)

Top ↑

Source Source

File: libraries/lifterlms-rest/includes/server/llms-rest-server-functions.php 

function llms_rest_authorization_required_error( $message = '', $check_authenticated = true ) {
	if ( $check_authenticated && is_user_logged_in() ) {
		// 403.
		$error_code = 'llms_rest_forbidden_request';
		$_message   = __( 'You are not authorized to perform this request.', 'lifterlms' );
		$status     = WP_Http::FORBIDDEN; // 403.
	} else {
		// 401.
		$error_code = 'llms_rest_unauthorized_request';
		$_message   = __( 'The API credentials were invalid.', 'lifterlms' );
		$status     = WP_Http::UNAUTHORIZED; // 401.
	}

	$message = ! $message ? $_message : $message;
	return new WP_Error( $error_code, $message, array( 'status' => $status ) );
}

Expand full source code Collapse full source code View on GitHub

Top ↑

Used By Used By

Used By
Used By Description
libraries/lifterlms-rest/includes/abstracts/class-llms-rest-posts-controller.php: LLMS_REST_Posts_Controller::sanitize_post_statuses()

Sanitizes and validates the list of post statuses, including whether the user can query private statuses
libraries/lifterlms-rest/includes/abstracts/class-llms-rest-controller.php: LLMS_REST_Controller::prepare_collection_query_search_args()

Format search query arguments to retrieve a collection of objects.
libraries/lifterlms-rest/includes/server/class-llms-rest-students-controller.php: LLMS_REST_Students_Controller::update_item_permissions_check()

Determine if current user has permission to update a user.
libraries/lifterlms-rest/includes/server/class-llms-rest-students-controller.php: LLMS_REST_Students_Controller::get_items_permissions_check()

Determine if current user has permission to list users.
libraries/lifterlms-rest/includes/server/class-llms-rest-students-controller.php: LLMS_REST_Students_Controller::get_item_permissions_check()

Determine if current user has permission to get a user.
libraries/lifterlms-rest/includes/server/class-llms-rest-students-controller.php: LLMS_REST_Students_Controller::delete_item_permissions_check()

Determine if current user has permission to delete a user.
libraries/lifterlms-rest/includes/server/class-llms-rest-students-controller.php: LLMS_REST_Students_Controller::create_item_permissions_check()

Determine if current user has permission to create a user.
libraries/lifterlms-rest/includes/server/class-llms-rest-enrollments-controller.php: LLMS_REST_Enrollments_Controller::delete_item_permissions_check()

Check if a given request has access to delete an item.
libraries/lifterlms-rest/includes/server/class-llms-rest-enrollments-controller.php: LLMS_REST_Enrollments_Controller::update_item_permissions_check()

Check if a given request has access to update an item.
libraries/lifterlms-rest/includes/server/class-llms-rest-enrollments-controller.php: LLMS_REST_Enrollments_Controller::create_item_permissions_check()

Check if a given request has access to create an item.
libraries/lifterlms-rest/includes/server/class-llms-rest-enrollments-controller.php: LLMS_REST_Enrollments_Controller::get_item_permissions_check()

Check if a given request has access to read an item.
libraries/lifterlms-rest/includes/server/class-llms-rest-enrollments-controller.php: LLMS_REST_Enrollments_Controller::get_items_permissions_check()

Check if a given request has access to read items.
libraries/lifterlms-rest/includes/server/class-llms-rest-webhooks-controller.php: LLMS_REST_Webhooks_Controller::check_permissions()

Check if the authenticated user can perform the request action.
libraries/lifterlms-rest/includes/server/class-llms-rest-instructors-controller.php: LLMS_REST_Instructors_Controller::update_item_permissions_check()

Determine if current user has permission to update a user.
libraries/lifterlms-rest/includes/server/class-llms-rest-instructors-controller.php: LLMS_REST_Instructors_Controller::get_items_permissions_check()

Determine if current user has permission to list users.
libraries/lifterlms-rest/includes/server/class-llms-rest-instructors-controller.php: LLMS_REST_Instructors_Controller::delete_item_permissions_check()

Determine if current user has permission to delete a user.
libraries/lifterlms-rest/includes/server/class-llms-rest-instructors-controller.php: LLMS_REST_Instructors_Controller::get_item_permissions_check()

Determine if current user has permission to get a user.
libraries/lifterlms-rest/includes/server/class-llms-rest-instructors-controller.php: LLMS_REST_Instructors_Controller::create_item_permissions_check()

Determine if current user has permission to create a user.
libraries/lifterlms-rest/includes/server/class-llms-rest-students-progress-controller.php: LLMS_REST_Students_Progress_Controller::update_item_permissions_check()

Determine if current user has permission to create/update an enrollment.
libraries/lifterlms-rest/includes/server/class-llms-rest-students-progress-controller.php: LLMS_REST_Students_Progress_Controller::get_item_permissions_check()

Check if a given request has access to read an item.
libraries/lifterlms-rest/includes/server/class-llms-rest-students-progress-controller.php: LLMS_REST_Students_Progress_Controller::delete_item_permissions_check()

Determine if current user has permission to delete a user.
libraries/lifterlms-rest/includes/server/class-llms-rest-api-keys-controller.php: LLMS_REST_API_Keys_Controller::check_permissions()

Check if the authenticated user can perform the request action.
libraries/lifterlms-rest/includes/abstracts/class-llms-rest-users-controller.php: LLMS_REST_Users_Controller::check_roles_permissions()

Determine if the current user has permissions to manage the role(s) present in a request
libraries/lifterlms-rest/includes/abstracts/class-llms-rest-posts-controller.php: LLMS_REST_Posts_Controller::handle_status_param()

Determines validity and normalizes the given status parameter.
libraries/lifterlms-rest/includes/abstracts/class-llms-rest-posts-controller.php: LLMS_REST_Posts_Controller::delete_item_permissions_check()

Check if a given request has access to delete an item.
libraries/lifterlms-rest/includes/abstracts/class-llms-rest-posts-controller.php: LLMS_REST_Posts_Controller::update_item_permissions_check()

Check if a given request has access to update an item.
libraries/lifterlms-rest/includes/abstracts/class-llms-rest-posts-controller.php: LLMS_REST_Posts_Controller::get_item_permissions_check()

Check if a given request has access to read an item.
libraries/lifterlms-rest/includes/abstracts/class-llms-rest-posts-controller.php: LLMS_REST_Posts_Controller::create_item_permissions_check()

Check if a given request has access to create an item.
libraries/lifterlms-rest/includes/abstracts/class-llms-rest-posts-controller.php: LLMS_REST_Posts_Controller::get_items_permissions_check()

Check if a given request has access to read items.
libraries/lifterlms-rest/includes/class-llms-rest-authentication.php: LLMS_REST_Authentication::authenticate()

Authenticate an API Request
libraries/lifterlms-rest/includes/class-llms-rest-authentication.php: LLMS_REST_Authentication::check_permissions()

Check if the API Key can perform the request.
Show 26 more used by Hide more used by

Top ↑

Changelog Changelog

Changelog
Version Description
1.0.0-beta.18 Use WP_Http constants for the error status.
1.0.0-beta.12 Added a second paramater to avoid checking if the user is logged in.
1.0.0-beta.1 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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