Browse: Home / Functions /

learndash_process_mark_complete

learndash_process_mark_complete( int|null $user_id = null,  int|null $postid = null,  boolean $onlycalculate = false,  int $course_id )

Updates the user meta with completion status for any resource.

Contents

Description #

Parameters #

$user_id

(int|null) (Optional) User ID.

Default value: null

$postid

(int|null) (Optional) The ID of the resource like course, lesson, topic, etc.

Default value: null

$onlycalculate

(boolean) (Optional) Whether to mark the resource as complete.

Default value: false

$course_id

(int) (Optional) Course ID. Default 0.

Return #

(boolean) Returns true if the meta is updated successfully otherwise false.

Source #

File: includes/course/ld-course-progress.php

Changelog #

Changelog
Version Description
2.1.0 Introduced.

Uses #

Uses
Uses Description
includes/course/ld-activity-functions.php: learndash_activity_update_meta_set ()

Update activity meta set.
includes/course/ld-activity-functions.php: learndash_activity_start_lesson ()

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

Set the topic activity completed record.
includes/course/ld-activity-functions.php: learndash_activity_complete_lesson ()

Set the lesson activity completed record.
includes/course/ld-activity-functions.php: learndash_activity_course_get_earliest_started ()

Get the earliest course activity record for the user.
includes/course/ld-activity-functions.php: learndash_activity_start_course ()

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

Utility function to check if Course Builder is enabled.
includes/course/ld-course-functions-legacy.php: learndash_process_mark_complete_legacy ()

LEGACY: Updates the user meta with completion status for any resource.
includes/classes/class-ldlms-model-user-course-progress.php: learndash_user_get_course_progress ()

Utility function to get a user’s progress for a single course.
includes/classes/class-ldlms-model-user-course-progress.php: learndash_user_set_course_progress ()

Utility function to update a user’s course progress instance.
includes/settings/settings-functions.php: learndash_get_setting ()

Gets the LearnDash setting for a post.
includes/class-ldlms-post-types.php: learndash_get_post_types ()
includes/course/ld-course-steps-functions.php: learndash_course_get_single_parent_step ()

Gets the single parent step ID for a given step ID in a course.
includes/course/ld-course-steps-functions.php: learndash_course_get_completed_steps ()

Gets the total completed steps for a given course progress array.
includes/course/ld-course-steps-functions.php: learndash_get_course_steps_count ()

Gets the total count of lessons and topics for a given course ID.
includes/course/ld-activity-functions.php: learndash_get_user_activity ()

Gets the user activity.
includes/course/ld-activity-functions.php: learndash_update_user_activity ()

Updates the user activity.
includes/course/ld-course-functions.php: learndash_get_course_id ()

Gets the course ID for a resource.
includes/course/ld-course-progress.php: learndash_process_mark_complete

Filters whether to mark a process complete.
includes/course/ld-course-progress.php: learndash_before_course_completed

Fires before the course is marked completed.
includes/course/ld-course-progress.php: learndash_lesson_completed

Fires after the lesson is marked completed.
includes/course/ld-course-progress.php: learndash_topic_completed

Fires after the topic is marked completed.
includes/course/ld-course-progress.php: learndash_course_completed

Fires after the course is marked completed.

Used By #

Used By
Used By Description
includes/ld-users.php: learndash_process_user_course_progress_update ()

Process user course progress changes.
includes/course/ld-course-functions-legacy.php: learndash_course_status_legacy ()

LEGACY: Outputs the current status of the course.
includes/ld-assignment-uploads.php: learndash_approve_assignment ()

Marks assignment approved by user ID and lesson ID.
includes/quiz/ld-quiz-pro.php: LD_QuizPro::wp_pro_quiz_completed ()

This function runs when a quiz is completed, and does the action ‘wp_pro_quiz_completed_quiz’
includes/quiz/ld-quiz-essays.php: learndash_update_quiz_data ()

Updates the user’s quiz data.
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_next_lesson_quiz ()

Gets the next quiz for current lesson for a user.
includes/course/ld-course-progress.php: learndash_course_status ()

Outputs the current status of the course.
includes/course/ld-course-progress.php: learndash_update_completion ()

Marks a resource complete.
includes/course/ld-course-progress.php: learndash_lesson_topics_completed ()

Checks if the lesson topics are completed.
includes/course/ld-course-progress.php: learndash_mark_complete_process ()

Processes a request to mark a course complete.