Contents

Code Reference Classes BP_REST_Learndash_Courses_Endpoint BP_REST_Learndash_Courses_Endpoint::get_items()

BP_REST_Learndash_Courses_Endpoint::get_items( WP_REST_Request $request )

Retrieve courses.

Description

Parameters

$request

(Required) Full details about the request.

Return

(WP_REST_Response) | WP_Error

Source

File: bp-integrations/learndash/classes/class-bp-rest-learndash-courses-endpoint.php

83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
public function get_items( $request ) {
 
    $args = array(
        'post_type'      => 'sfwd-courses',
        'order'          => ( ! empty( $request['order'] ) ? $request['order'] : 'desc' ),
        'orderby'        => ( ! empty( $request['orderby'] ) ? $request['orderby'] : 'date' ),
        'paged'          => ( ! empty( $request['page'] ) ? $request['page'] : 1 ),
        'posts_per_page' => ( ! empty( $request['per_page'] ) ? $request['per_page'] : 10 ),
        'post_status'    => ( ! empty( $request['status'] ) ? implode( ' ', $request['status'] ) : 'publish' ),
    );
 
    if ( ! empty( $request['search'] ) ) {
        $args['s'] = sanitize_title( trim( $request['search'] ) );
    }
 
    if ( ! empty( $request['author'] ) ) {
        $args['author'] = $request['author'];
    }
 
    if ( ! empty( $request['author_exclude'] ) ) {
        $args['author__not_in'] = $request['author_exclude'];
    }
 
    if ( ! empty( $request['exclude'] ) ) {
        $args['post__not_in'] = $request['exclude'];
    }
 
    if ( ! empty( $request['include'] ) ) {
        $args['post__in'] = $request['include'];
    }
 
    if ( ! empty( $request['offset'] ) ) {
        $args['offset'] = $request['offset'];
    }
 
    $args['date_query'] = array();
    // Set before into date query. Date query must be specified as an array of an array.
    if ( isset( $request['before'] ) ) {
        $args['date_query'][0]['before'] = $request['before'];
    }
 
    // Set after into date query. Date query must be specified as an array of an array.
    if ( isset( $request['after'] ) ) {
        $args['date_query'][0]['after'] = $request['after'];
    }
 
    if ( ! empty( $request['course_category'] ) ) {
        if ( in_array( 0, $request['course_category'], true ) ) {
            $args['tax_query'][] = array(
                'taxonomy' => 'ld_course_category',
                'operator' => 'NOT EXISTS',
            );
            $categories          = array();
            foreach ( $request['course_category'] as $k => $v ) {
                if ( ! empty( $v ) ) {
                    $categories[] = $v;
                }
            }
            $request['course_category'] = $categories;
            unset( $categories );
        }
 
        if ( ! empty( $request['course_category'] ) ) {
            $args['tax_query'][] = array(
                'taxonomy'         => 'ld_course_category',
                'field'            => 'term_id',
                'terms'            => $request['course_category'],
                'include_children' => false,
            );
        }
    }
 
    if ( ! empty( $request['course_category_exclude'] ) ) {
        $args['tax_query'][] = array(
            'taxonomy'         => 'ld_course_category',
            'field'            => 'term_id',
            'terms'            => $request['course_category_exclude'],
            'include_children' => false,
            'operator'         => 'NOT IN',
        );
    }
 
    if ( ! empty( $request['course_tag'] ) ) {
        $args['tax_query'][] = array(
            'taxonomy'         => 'ld_course_tag',
            'field'            => 'term_id',
            'terms'            => $request['course_tag'],
            'include_children' => false,
        );
    }
 
    if ( ! empty( $request['course_tag_exclude'] ) ) {
        $args['tax_query'][] = array(
            'taxonomy'         => 'ld_course_tag',
            'field'            => 'term_id',
            'terms'            => $request['course_tag_exclude'],
            'include_children' => false,
            'operator'         => 'NOT IN',
        );
    }
 
    if ( isset( $request['group_id'] ) && ! empty( $request['group_id'] ) ) {
        $group_id         = bp_ld_sync( 'buddypress' )->helpers->getLearndashGroupId( $request['group_id'] );
        $course_ids       = learndash_group_enrolled_courses( $group_id );
        $args['post__in'] = ! empty( $course_ids ) ? $course_ids : array( 0 );
        unset( $args['author'] );
    }
 
    /**
     * Filter the query arguments for the request.
     *
     * @param array           $args    Key value array of query var to query value.
     * @param WP_REST_Request $request The request sent to the API.
     *
     * @since 0.1.0
     */
    $args = apply_filters( 'bp_rest_learndash_courses_get_items_query_args', $args, $request );
 
    $courses_query = new WP_Query( $args );
    $courses       = $courses_query->posts;
 
    $retval = array();
    if ( ! empty( $courses ) ) {
        foreach ( $courses as $course ) {
            $retval[] = $this->prepare_response_for_collection(
                $this->prepare_item_for_response( $course, $request )
            );
        }
    }
 
    $response = rest_ensure_response( $retval );
    $response = bp_rest_response_add_total_headers( $response, $courses_query->found_posts, $args['posts_per_page'] );
 
    /**
     * Fires after a list of courses is fetched via the REST API.
     *
     * @param array            $courses  Fetched Courses.
     * @param WP_REST_Response $response The response data.
     * @param WP_REST_Request  $request  The request sent to the API.
     *
     * @since 0.1.0
     */
    do_action( 'bp_rest_learndash_courses_get_items', $courses, $response, $request );
 
    return $response;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

Uses

Uses
Uses Description
bp-core/bp-core-rest-api.php: bp_rest_response_add_total_headers()

Set headers to let the Client Script be aware of the pagination.
bp-integrations/learndash/classes/class-bp-rest-learndash-courses-endpoint.php: BP_REST_Learndash_Courses_Endpoint::prepare_item_for_response()

Prepares component data for return as an object.
bp-integrations/learndash/classes/class-bp-rest-learndash-courses-endpoint.php: bp_rest_learndash_courses_get_items_query_args

Filter the query arguments for the request.
bp-integrations/learndash/classes/class-bp-rest-learndash-courses-endpoint.php: bp_rest_learndash_courses_get_items

Fires after a list of courses is fetched via the REST API.
bp-integrations/learndash/bp-learndash-functions.php: bp_ld_sync()

Return specified BuddyBoss LearnDash sync component.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.