• LifterLMS
  • Knowledge Base
  • Academy
  • Blog
  • Podcast
  • Contributors
  • My Account

LifterLMS LifterLMS

  • Code Reference
  • REST API
  • LLMS-CLI

Code Reference

Skip to content
Filter by type:
Search
Browse: Home / Code Reference / Classes / LLMS_REST_Enrollments_Controller / LLMS_REST_Enrollments_Controller::delete_item_permissions_check()

LLMS_REST_Enrollments_Controller::delete_item_permissions_check( WP_REST_Request $request )

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

Contents

  • Parameters
  • Return
  • Source
  • Related
    • Uses
  • Changelog
  • User Contributed Notes

Parameters #Parameters

$request

(WP_REST_Request) (Required) Full details about the request.


Top ↑

Return #Return

(WP_Error|boolean)


Top ↑

Source #Source

File: libraries/lifterlms-rest/includes/server/class-llms-rest-enrollments-controller.php

	public function delete_item_permissions_check( $request ) {

		$enrollment_exists = $this->enrollment_exists( (int) $request['id'], (int) $request['post_id'], $request['trigger'] );
		if ( is_wp_error( $enrollment_exists ) ) {
			// Enrollment not found, we don't return a 404.
			if ( in_array( 'llms_rest_not_found', $enrollment_exists->get_error_codes(), true ) ) {
				return true;
			}

			return $enrollment_exists;
		}

		if ( ! $this->check_delete_permission() ) {
			return llms_rest_authorization_required_error(
				sprintf(
					// Translators: %s = The post type name.
					__( 'Sorry, you are not allowed to delete enrollments as this user.', 'lifterlms' ),
					get_post_type_object( $this->post_type )->labels->name
				)
			);

		}

		return true;

	}

Expand full source code Collapse full source code View on GitHub


Top ↑

Related #Related

Uses #Uses

Uses
Uses Description
libraries/lifterlms-rest/includes/server/class-llms-rest-enrollments-controller.php: LLMS_REST_Enrollments_Controller::check_delete_permission()

Checks if an enrollment can be deleted

libraries/lifterlms-rest/includes/server/class-llms-rest-enrollments-controller.php: LLMS_REST_Enrollments_Controller::enrollment_exists()

Check enrollment existence.

libraries/lifterlms-rest/includes/server/llms-rest-server-functions.php: llms_rest_authorization_required_error()

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


Top ↑

Changelog #Changelog

Changelog
Version Description
1.0.0-beta.18 Provide a more significant error message when trying to delete an item without permissions.
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.

© 2014 - 2023 LifterLMS · Privacy Policy · Terms and Conditions

Insert/edit link

Enter the destination URL

Or link to existing content

    No search term specified. Showing recent items. Search or use up and down arrow keys to select an item.