LLMS_REST_Students_Controller::get_collection_params()

Retrieves the query params for the objects collection.

Contents

Return Return

(array) Collection parameters.

Top ↑

Source Source

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

107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
public function get_collection_params() {
 
    $params = parent::get_collection_params();
 
    $params['enrolled_in'] = array(
        'description' => __( 'Retrieve only students enrolled in the specified course(s) and/or membership(s). Accepts a single WP Post ID or a comma separated list of IDs.', 'lifterlms' ),
        'type'        => 'array',
        'items'       => array(
            'type' => 'integer',
        ),
    );
 
    $params['enrolled_not_in'] = array(
        'description' => __( 'Retrieve only students not enrolled in the specified course(s) and/or membership(s). Accepts a single WP Post ID or a comma separated list of IDs.', 'lifterlms' ),
        'type'        => 'array',
        'items'       => array(
            'type' => 'integer',
        ),
    );
 
    return $params;
 
}
 
/**

Expand full source code Collapse full source code View on GitHub

Top ↑

Top ↑

Changelog Changelog

Changelog
Version Description
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.