llms_get_enrolled_students( int $post_id, string|array $statuses = 'enrolled', integer $limit = 50, integer $skip )

Get an array of student IDs based on enrollment status a course or membership


Description Description


Parameters Parameters

$post_id

(int) (Required) WP_Post id of a course or membership

$statuses

(string|array) (Optional) list of enrollment statuses to query by status query is an OR relationship

Default value: 'enrolled'

$limit

(integer) (Optional) number of results

Default value: 50

$skip

(integer) (Required) number of results to skip (for pagination)


Top ↑

Return Return

(array)


Top ↑

Source Source

File: includes/llms.functions.core.php

function llms_get_enrolled_students( $post_id, $statuses = 'enrolled', $limit = 50, $skip = 0 ) {

	$query = new LLMS_Student_Query( array(
		'post_id' => $post_id,
		'statuses' => $statuses,
		'page' => ( 0 === $skip ) ? 1 : ( $skip / $limit ) + 1,
		'per_page' => $limit,
		'sort' => array(
			'id' => 'ASC',
		),
	) );

	if ( $query->results ) {
		return wp_list_pluck( $query->results, 'id' );
	}

	return array();
}

Top ↑

Changelog Changelog

Changelog
Version Description
3.0.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

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