LLMS_REST_Enrollments_Controller::enrollment_exists( int $student_id, int $post_id, string $trigger = 'any', boolean $wp_error = true )

Check enrollment existence.


Parameters Parameters

$student_id

(int) (Required) Student ID.

$post_id

(int) (Required) The course/membership ID.

$trigger

(string) (Optional) The enrollment trigger.

Default value: 'any'

$wp_error

(boolean) (Optional) Whether return a WP_Error instance or a boolean. Default true (returns WP_Error).

Default value: true


Top ↑

Return Return

(WP_Error|boolean)


Top ↑

Source Source

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

	protected function enrollment_exists( $student_id, $post_id, $trigger = 'any', $wp_error = true ) {

		$student = llms_get_student( $student_id );

		if ( empty( $student ) ) {
			return $wp_error ? llms_rest_not_found_error() : false;
		}

		$current_status = $student->get_enrollment_status( $post_id );

		if ( empty( $current_status ) ) {
			return $wp_error ? llms_rest_not_found_error() : false;
		}

		if ( 'any' !== $trigger && $trigger !== $student->get_enrollment_trigger( $post_id ) ) {
			return $wp_error ? llms_rest_not_found_error() : false;
		}

		return true;

	}


Top ↑

Changelog Changelog

Changelog
Version Description
1.0.0-beta.10 Added the trigger param.
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.