LLMS_Student::get_enrollments( string $post_type = 'course', array $args = array() )
Retrieve IDs of user’s enrollments by post type (and additional criteria)
Parameters Parameters
- $post_type
-
(string) (Optional) name of the post type (course|membership)
Default value: 'course'
- $args
-
(array) (Optional) query arguments @arg int $limit number of courses to return @arg string $orderby table reference and field to order results by @arg string $order result order (DESC, ASC) @arg int $skip number of results to skip for pagination purposes @arg string $status filter results by enrollment status, "any", "enrolled", "cancelled", or "expired"
Default value: array()
Return Return
(array) "results" will contain an array of course ids "more" will contain a boolean determining whether or not more courses are available beyond supplied limit/skip criteria "found" will contain the total possible FOUND_ROWS() for the query
Source Source
File: includes/models/model.llms.student.php
public function get_completion_date( $object_id, $format = 'F d, Y' ) { global $wpdb; $q = $wpdb->get_var( $wpdb->prepare( "SELECT updated_date FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE meta_key = '_is_complete' AND meta_value = 'yes' AND user_id = %d AND post_id = %d ORDER BY updated_date DESC LIMIT 1", array( $this->get_id(), $object_id ) ) ); // db call ok; no-cache ok. return ( $q ) ? date_i18n( $format, strtotime( $q ) ) : false; } /** * Retrieve IDs of user's enrollments by post type (and additional criteria) * * @param string $post_type name of the post type (course|membership) * @param array $args query arguments * @arg int $limit number of courses to return * @arg string $orderby table reference and field to order results by * @arg string $order result order (DESC, ASC) * @arg int $skip number of results to skip for pagination purposes * @arg string $status filter results by enrollment status, "any", "enrolled", "cancelled", or "expired" * @return array "results" will contain an array of course ids * "more" will contain a boolean determining whether or not more courses are available beyond supplied limit/skip criteria * "found" will contain the total possible FOUND_ROWS() for the query * @since 3.0.0 * @version 3.15.1 */ public function get_enrollments( $post_type = 'course', $args = array() ) { global $wpdb; $args = wp_parse_args( $args, array( 'limit' => 20, 'orderby' => 'upm.updated_date', 'order' => 'DESC', 'skip' => 0, 'status' => 'any', // Any, enrolled, cancelled, expired. ) ); // Prefix membership. if ( 'membership' === $post_type ) { $post_type = 'llms_membership'; } // Sanitize order & orderby. $args['orderby'] = preg_replace( '/[^a-zA-Z_.]/', '', $args['orderby'] ); $args['order'] = preg_replace( '/[^a-zA-Z_.]/', '', $args['order'] ); // Allow "short" orderby's to be passed in without a table reference. switch ( $args['orderby'] ) { case 'date': $args['orderby'] = 'upm.updated_date'; break; case 'order': $args['orderby'] = 'p.menu_order'; break; case 'title': $args['orderby'] = 'p.post_title'; break; } // Prepare additional status AND clauses. if ( 'any' !== $args['status'] ) { $status = $wpdb->prepare( " AND upm.meta_value = %s AND upm.updated_date = ( SELECT MAX( upm2.updated_date ) FROM {$wpdb->prefix}lifterlms_user_postmeta AS upm2 WHERE upm2.meta_key = '_status' AND upm2.user_id = %d AND upm2.post_id = upm.post_id )", $args['status'], $this->get_id() ); } else { $status = ''; } // phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared $query = $wpdb->get_results( $wpdb->prepare( "SELECT SQL_CALC_FOUND_ROWS DISTINCT upm.post_id AS id FROM {$wpdb->prefix}lifterlms_user_postmeta AS upm
Expand full source code Collapse full source code View on GitHub
Changelog Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |