Skip to main content

Topic

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

Query parameters​

  • completion_status - Topic 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

  • lesson - Lesson ID or "current" for current lesson
    Type: string

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

Fields​

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

  • topic_assignments_deletion - Assignment deletion enabled

  • topic_assignments_enabled - Is assignment enabled

  • topic_assignments_extensions - Assignment file extensions limit

  • topic_assignments_form - Renders Assignment upload form.

  • topic_assignments_points - Assignment points enabled

  • topic_assignments_points_amount - Assignment points amount

  • topic_assignments_size - Assignment file size limit

  • topic_assignments_upload - Assignment file uploads number limit

  • topic_has_next_topic - Has next topic

  • topic_has_previous_topic - Has previous topic

  • topic_mark_complete - Mark Complete button

  • topic_materials - Topic materials

  • topic_next_step - Next step

  • topic_next_step_id - Next step Id

  • topic_next_step_title - Next step Title

  • topic_next_step_url - Next step URL

  • topic_next_topic_id - Next topic id

  • topic_next_topic_link - Next topic link

  • topic_next_topic_title - Next topic title

  • topic_next_topic_url - Next topic url

  • topic_parent_course_id - Topic parent Course id

  • topic_parent_course_title - Topic parent Course Title

  • topic_parent_course_url - Topic parent Course URL

  • topic_parent_lesson_id - Topic parent Lesson id

  • topic_parent_lesson_title - Topic parent Lesson Title

  • topic_parent_lesson_url - Topic parent Lesson URL

  • topic_previous_step - Previous step

  • topic_previous_step_id - Previous step Id

  • topic_previous_step_title - Previous step Title

  • topic_previous_step_url - Previous step URL

  • topic_previous_topic_id - Previous topic id

  • topic_previous_topic_link - Previous topic link

  • topic_previous_topic_title - Previous topic title

  • topic_previous_topic_url - Previous topic url

  • topic_progress_completed - Topic completed steps

  • topic_progress_percent - Topic progress percent

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

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

  • topic_progress_total - Topic total steps

  • topic_step_number_course - Topic Step Number relative to Course - WITHOUT Quizzes counted

  • topic_step_number_course_q - Topic Step Number relative to Course - WITH Quizzes counted

  • topic_step_number_lesson - Topic Step Number relative to parent Lesson - WITHOUT Quizzes counted

  • topic_step_number_lesson_q - Topic Step Number relative to parent Lesson - WITH Quizzes counted

  • topic_time_enabled - If Forced time enabled or not.

  • topic_timer - Display timer countdown.

  • topic_video - Renders Video.

  • topic_video_auto_complete - Mark the topic as completed once the user has watched the full video.

  • topic_video_auto_complete_delay - Delay between video completion and topic completion.

  • topic_video_auto_start - Video auto-start or not.

  • topic_video_enabled - Video enabled or not.

  • topic_video_exist - Video exists or not.

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

  • topic_video_show_complete_button - Display the Mark Complete button on a topic even if not yet clickable.

  • topic_video_show_controls - Show Video controls or not.

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

  • topic_video_track_time - Allows user to resume video position.

  • topic_video_url - Video URL.