Browse: Home / Hooks /

learndash_rest_users_course_progress_query

apply_filters( 'learndash_rest_users_course_progress_query',  array $args,  WP_REST_Request $request )

Filters the query arguments for user course progress REST request.

Contents

Description #

Enables adding extra arguments or setting defaults for a post collection request.

Parameters #

$args

(array) An array of query arguments for getting users course progress.

$request

(WP_REST_Request) The REST request object.

Source #

File: includes/rest-api/v1/class-ld-rest-users-course-progress-controller.php

Examples #

Note: Extended code example below not guaranteed, you may need to consult with a developer

 <?php
/**
 * Example usage for learndash_rest_users_course_progress_query filter.
 */
add_filter(
	'learndash_rest_users_course_progress_query',
	function( $args, $request ) {
		// May add any custom logic using $args, $request.

		// Always return $args.
		return $args;
	},
	10,
	2
);

Expand example code Copy to clipboard

Changelog #

Changelog
Version Description
2.5.8 Introduced.