Skip to main content

Lesson

For loop type learndash_lesson, here are the query parameters and fields.

Query parameters​

  • completion_status - Lesson completion status ('open', 'started', 'completed', 'locked')
    Type: string, array

  • course - Course ID or "current" for current course
    Type: string

  • enrolled - Current user is enrolled
    Type: boolean

  • video_exists - Lesson video exists, true or false
    Type: boolean

Fields​

  • lesson_assignments_auto_approve - Assignment grading type(Auto-approve, Manually grade)

  • lesson_assignments_deletion - Assignment deletion enabled

  • lesson_assignments_enabled - Is assignment enabled

  • lesson_assignments_extensions - Assignment file extensions limit

  • lesson_assignments_form - Renders Assignment upload form.

  • lesson_assignments_points - Assignment points enabled

  • lesson_assignments_points_amount - Assignment points amount

  • lesson_assignments_size - Assignment file size limit

  • lesson_assignments_upload - Assignment file uploads number limit

  • lesson_drip_date - Drip date - Optionally use "date_format" attribute

  • lesson_drip_date_future - Drip date is in the future (after today)

  • lesson_drip_date_past - Drip date is in the past (before and including today)

  • lesson_drip_date_timestamp - Drip date timestamp

  • lesson_drip_enabled - Lesson Drip enabled or not

  • lesson_has_next_lesson - Has next lesson

  • lesson_has_previous_lesson - Has previous lesson

  • lesson_has_section - If Lesson has a section(if it is a first lesson under a section) - bool

  • lesson_is_sample - If the lesson is sample or not

  • lesson_mark_complete - Mark Complete button

  • lesson_materials - Lesson materials

  • lesson_next_lesson_id - Next lesson id

  • lesson_next_lesson_link - Next lesson link

  • lesson_next_lesson_title - Next lesson title

  • lesson_next_lesson_url - Next lesson url

  • lesson_next_step - Next step

  • lesson_next_step_id - Next step Id

  • lesson_next_step_title - Next step Title

  • lesson_next_step_url - Next step URL

  • lesson_number_no_children - Lesson Number relative to Course - NO Topics and Quizzes counted

  • lesson_parent_course_id - Lesson parent Course id

  • lesson_parent_course_title - Lesson parent Course Title

  • lesson_parent_course_url - Lesson parent Course URL

  • lesson_previous_lesson_id - Previous lesson id

  • lesson_previous_lesson_link - Previous lesson link

  • lesson_previous_lesson_title - Previous lesson title

  • lesson_previous_lesson_url - Previous lesson url

  • lesson_previous_step - Previous step

  • lesson_previous_step_id - Previous step Id

  • lesson_previous_step_title - Previous step Title

  • lesson_previous_step_url - Previous step URL

  • lesson_progress_completed - Lesson completed steps - Quizzes not counted as steps

  • lesson_progress_completed_q - Lesson completed steps - Quizzes counted as steps

  • lesson_progress_percent - Lesson progress percent - Quizzes not counted as steps

  • lesson_progress_percent_q - Lesson progress percent - Quizzes counted as steps

  • lesson_progress_status - Progress status: open, started, completed, or locked

  • lesson_progress_status_label - Progress status label: Not Started, In Progress, Completed, or Locked

  • lesson_progress_total - Lesson total steps - Quizzes not counted as steps

  • lesson_progress_total_q - Lesson total steps - Quizzes counted as steps

  • lesson_schedule - Lesson schedule : After Course Enrollment - value "after_course_enrolled" / After Specific Date - value "after_specific_date"

  • lesson_section_is_expanded - If the section is expanded - bool

  • lesson_section_order - Section order

  • lesson_section_title - Section title

  • lesson_section_type - Section type

  • lesson_section_url - Section URL

  • lesson_step_number - Lesson Step Number relative to Course - WITHOUT Quizzes counted

  • lesson_step_number_q - Lesson Step Number relative to Course - WITH Quizzes counted

  • lesson_time_enabled - If Forced time enabled or not.

  • lesson_timer - Display timer countdown.

  • lesson_video - Renders Video.

  • lesson_video_auto_complete - Mark the lesson as completed once the user has watched the full video.

  • lesson_video_auto_complete_delay - Delay between video completion and lesson completion.

  • lesson_video_auto_start - Video auto-start or not.

  • lesson_video_enabled - Video enabled or not.

  • lesson_video_exist - Video exists or not.

  • lesson_video_focus_pause - Pause the video if user switches to a different window..

  • lesson_video_show_complete_button - Display the Mark Complete button on a lesson even if not yet clickable.

  • lesson_video_show_controls - Show Video controls or not.

  • lesson_video_shown - Video available "before" or "after" completed sub-steps.

  • lesson_video_track_time - Allows user to resume video position.

  • lesson_video_url - Video URL.