Browse: Home / Functions /

learndash_reports_get_activity

learndash_reports_get_activity( $query_args = array(),  int $current_user_id )

Queries the user activity for the report.

Contents

Description #

This function will query the new learndash_course_user_activity table for user/course Activity.

Parameters #

(<span class="arrayarray<string,) (Required) mixed> $query_args Optional. The query arguments to get user activity. Default empty array.

$current_user_id

(int) (Optional) The user to run the query as. Defaults to the current user. Default 0.

Return #

(array|int) Returns user activity query results or the number of items if 'return_count_only' in $query_args is set to true.

Source #

File: includes/ld-reports.php

Changelog #

Changelog
Version Description
4.21.1 NOT_STARTED data is now included properly in the results. If you need to include *all* "access" activities for a User/Course combination, set 'always_include_access_results' to true in $query_args. By default, if a User/Course combination would have IN_PROGRESS or COMPLETED activities, access activities are not included.
4.20.5 Changed the main table to query from to 'wp_learndash_user_activity' instead of 'wp_users'. 4.20.5 Activity meta fields are fetched via a join query. Added the 'return_count_only' parameter to the $query_args.
2.3.0 Introduced.

Uses #

Uses
Uses Description
includes/ld-reports.php: learndash_user_activity_meta_query_where

Filters the where condition of the user activity meta query.
includes/ld-reports.php: learndash_user_activity_query_group_by

Filters the group by part of the user activity query.
includes/ld-reports.php: learndash_user_activity_meta_query_joins

Filters the joins for the user activity meta query.
includes/ld-reports.php: learndash_user_activity_results
src/Core/Utilities/Cast.php: Cast::to_int ()

Casts a value to a int if possible or returns an empty string.
includes/class-ldlms-db.php: LDLMS_DB::escape_numeric_array ()

Escape an array, supposed to be a numeric array, to be used in a SQL IN() clause.
includes/class-ldlms-db.php: LDLMS_DB::escape_string_array ()

Escape a string array to be used in a SQL IN() clause.
includes/ld-misc-functions.php: learndash_adjust_date_time_display ()

Converts a GMT timestamp to local timezone adjusted display.
includes/ld-users.php: learndash_user_get_enrolled_courses ()

Gets the list of all courses enrolled by the user.
includes/class-ldlms-db.php: LDLMS_DB::get_table_name ()

Utility function to return the table name. This is to prevent hard-coding of the table names throughout the code files.
includes/ld-reports.php: learndash_get_activity_query_args

Filters query arguments for getting user activity.
includes/ld-reports.php: learndash_user_activity_query_fields

Filters user activity query fields.
includes/ld-reports.php: learndash_user_activity_query_tables

Filters tables and joins to be used for user activity query. The from part of the query with valid SQL syntax.
includes/ld-reports.php: learndash_user_activity_query_joins

Filters the joins for the user activity query.
includes/ld-reports.php: learndash_user_activity_query_where

Filters the where condition of the user activity query.
includes/ld-reports.php: learndash_user_activity_query_order

Filters the order by part of the user activity query.
includes/ld-reports.php: learndash_user_activity_query_limit

Filters the limit part of the user activity query.
includes/ld-reports.php: learndash_user_activity_query_str

Filters the user activity SQL query string.
includes/ld-reports.php: learndash_get_group_leader_groups_users ()

Returns the list of user IDs managed by the group leader.

Used By #

Used By
Used By Description
includes/reports/includes/class-ld-propanel-filtering.php: LearnDash_ProPanel_Filtering::ajax_email_users ()
includes/reports/includes/class-ld-propanel-activity.php: LearnDash_ProPanel_Activity::activity_template_rows ()

Build Activity Rows
includes/reports/includes/class-ld-propanel-reporting.php: LearnDash_ProPanel_Reporting::ajax_email_users ()
includes/reports/templates/reporting-filters/courses/ld-propanel-reporting-filter-course.php: LearnDash_ProPanel_Reporting_Filter_Courses::filter_result_rows ()
includes/reports/templates/reporting-filters/users/ld-propanel-reporting-filter-user.php: LearnDash_ProPanel_Reporting_Filter_Users::filter_result_rows ()
includes/reports/templates/reporting-filters/groups/ld-propanel-reporting-filter-group.php: LearnDash_ProPanel_Reporting_Filter_Groups::filter_result_rows ()
includes/ld-users.php: learndash_process_user_course_progress_update ()

Process user course progress changes.
includes/rest-api/v2/class-ld-rest-users-course-progress-controller.php: LD_REST_Users_Course_Progress_Controller_V2::get_user_course_activity ()

Get user course activity from DB.
includes/ld-reports.php: learndash_report_user_courses_progress ()

Gets the users course progress for the report.
includes/ld-reports.php: learndash_report_course_users_progress ()

Gets the user’s course progress for the report.
includes/shortcodes/ld_courseinfo.php: learndash_courseinfo ()

Builds the [courseinfo] shortcode output.
includes/course/ld-course-functions.php: learndash_user_get_course_completed_date ()

Gets the course completion date for a user.
includes/shortcodes/ld_course_list.php: ld_course_list ()

Builds the [ld_course_list] shortcode output.
includes/admin/classes-data-reports-actions/class-learndash-admin-data-reports-user-quizzes.php: Learndash_Admin_Data_Reports_Quizzes::process_report_action ()

Class method for the AJAX update logic This function will determine what users need to be converted. Then the course and quiz functions will be called to convert each individual user data set.
includes/admin/classes-data-reports-actions/class-learndash-admin-data-reports-user-courses.php: Learndash_Admin_Data_Reports_Courses::process_report_action ()

Class method for the AJAX update logic This function will determine what users need to be converted. Then the course and quiz functions will be called to convert each individual user data set.