Browse: Home / Functions /

learndash_get_user_activity

learndash_get_user_activity( array $args = array(),  bool $activity_create = false )

Gets the user activity.

Contents

Description #

Parameters #

$args

(array) (Optional) An array of user activity arguments.

  • 'course_id'
    (int) Optional. Course ID. Default 0.
  • 'activity_type'
    (string) Type of the activity.

Default value: array()

$activity_create

(bool) (Optional) It true will create to activity record.

Default value: false

Return #

(object|array|null) Activity object (LDLMS_Activity) or null if not found.

Source #

File: includes/course/ld-activity-functions.php

Changelog #

Changelog
Version Description
3.5.0 Added $activity_create param.
2.3.0 Introduced.

Uses #

Uses
Uses Description
includes/classes/class-ldlms-model-activity.php: LDLMS_Model_Activity::__construct ()

Class constructor.
includes/class-ldlms-post-types.php: learndash_is_valid_post_type ()

Utility function to check if a post type slug is a valid LearnDash post type.
includes/course/ld-activity-functions.php: learndash_get_user_activity

Filter for learndash_get_user_activity.
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/class-ldlms-post-types.php: learndash_get_post_type_key ()
includes/course/ld-activity-functions.php: learndash_update_user_activity ()

Updates the user activity.
includes/admin/class-learndash-admin-data-upgrades.php: learndash_data_upgrades_setting ()

Utility function to get the data upgrade settings.

Used By #

Used By
Used By Description
includes/course-grid/includes/functions.php: learndash_course_grid_prepare_template_post_attributes ()

Prepares post attributes for the course grid template.
includes/exam/ld-exam-functions.php: learndash_get_user_course_exam_activity ()

Get the User Course Exam Challenge Activity and Meta record.
includes/exam/ld-exam-functions.php: learndash_exam_process_ajax ()

Handle Exam actions via AJAX requests from WP Profile page.
includes/classes/class-ldlms-model-exam.php: LDLMS_Model_Exam::set_exam_activity ()

Set the Activity record and meta for the exam.
includes/course/ld-activity-functions.php: learndash_activity_start_step ()

Set the step activity started record.
includes/course/ld-activity-functions.php: learndash_activity_complete_step ()

Set the step activity completed record.
includes/classes/class-ldlms-model-user-quiz-resume.php: LDLMS_User_Quiz_Resume::get_user_quiz_resume_activity ()

Get the User Quiz Resume Activity and Meta record.
includes/course/ld-course-functions-legacy.php: learndash_process_mark_complete_legacy ()

LEGACY: Updates the user meta with completion status for any resource.
includes/ld-users.php: learndash_course_item_to_activity_sync ()

Syncs the course date with the user activity.
includes/quiz/ld-quiz-pro.php: LD_QuizPro::set_quiz_status_meta ()

This function runs when a quiz is started and is used to set the quiz start timestamp
includes/course/ld-activity-functions.php: learndash_update_user_activity ()

Updates the user activity.
includes/course/ld-course-progress.php: learndash_remove_user_quiz_attempt ()

Removes the quiz attempt meta for a given user.
includes/course/ld-course-progress.php: learndash_process_mark_incomplete ()

Marks a course step incomplete for a course.
includes/course/ld-course-progress.php: learndash_process_mark_complete ()

Updates the user meta with completion status for any resource.
includes/admin/classes-data-upgrades-actions/class-learndash-admin-data-upgrades-user-meta-courses.php: Learndash_Admin_Data_Upgrades_User_Meta_Courses::convert_user_meta_courses_progress_to_activity ()

Convert single user quiz attempts to Activity DB entries.