LLMS_REST_Instructors_Controller::prepare_collection_query_args( WP_REST_Request $request )

Format query arguments to retrieve a collection of objects


Parameters Parameters

$request

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


Top ↑

Return Return

(array|WP_Error)


Top ↑

Source Source

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

	protected function prepare_collection_query_args( $request ) {

		$query_args = parent::prepare_collection_query_args( $request );
		if ( is_wp_error( $query_args ) ) {
			return $query_args;
		}

		$instructor_roles = $this->get_instructor_roles();
		$default          = $this->get_item_schema_base()['properties']['roles']['default'];

		if ( empty( $request['roles'] ) ) {
			$roles = $default;
		} else {
			$roles = array_values( array_intersect( (array) $request['roles'], $instructor_roles ) );
			// Requested only non-instructor roles: return instructors only, never the requested role.
			if ( empty( $roles ) ) {
				$roles = $default;
			}
		}

		$query_args['roles'] = $roles;

		return $query_args;
	}


Top ↑

Changelog Changelog

Changelog
Version Description
1.0.2 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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