Skip to main content

Course

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

Query parameters​

  • access_type - Access type: Open(open), Free(free), Buy now(paynow), Recurring(subscribe), Closed(closed)
    Type: string, array

  • certificate_earned - Course Certificate earned or not
    Type: boolean

  • certificate_exists - Course Certificate exists or not
    Type: boolean

  • completion_status - Course Completion Status for the User: Not Started(open), In Progress(started), Completed(completed)
    Type: string, array

  • enrolled - Current user is enrolled
    Type: boolean

  • group_leader - Group Leader ID the Course belongs to
    Type: string

  • linked_group - Group ID the Course belongs to
    Type: string, array

  • order_by_field - Custom order by field
    Type: string

  • prerequisite_completed - Course Prerequisite completed or not
    Type: boolean

  • prerequisite_exists - Course Prerequisite exists or not
    Type: boolean

Fields​

  • course_access_expires - When a user will have access to the course.

  • course_certificate_data - Course certificate data loop.

  • course_certificate_id - Course certificate ID.

  • course_certificate_link - Course certificate link.

  • course_certificate_url - Course certificate URL.

  • course_content_table - Displays the Course Content table (lessons, topics, and quizzes)

  • course_content_table_ld - Displays the Course Content table - LearnDash template (lessons, topics, and quizzes)

  • course_date_completed - Course date completed

  • course_enroll - Take this course button

  • course_enrolled - Course is enrolled by current user

  • course_groups - List of Course groups

  • course_last_activity - Last User Activity

  • course_lessons - List of Course Lessons

  • course_lessons_number - Number of Course Lessons.

  • course_materials - Course materials.

  • course_next_step_id - Course next step Id

  • course_next_step_title - Course next step title

  • course_next_step_url - Course next step URL

  • course_points - Number of points awarded for completing the course.

  • course_points_access - Number of points required in order to gain access to the course.

  • course_price - Price

  • course_price_currency - Price Currency

  • course_price_type - Price type

  • course_price_type_label - Price type label

  • course_price_url - Price URL - Only for closed courses

  • course_progress - Displays the Course Progress bar

  • course_progress_percent - Course progress percent

  • course_quizzes - List of Course quizzes(final quizzes)

  • course_quizzes_all - List of all Course, Lessons and Topics quizzes

  • course_quizzes_number - Number of Course Quizzes.

  • course_resume_id - Course Resume - first incomplete step id

  • course_resume_title - Course Resume - first incomplete step title

  • course_resume_url - Course Resume - first incomplete step url

  • course_since - From when the Course is available.

  • course_status - Course status ('Not Started', 'In Progress', 'Completed' converted to 'open', 'started', 'completed')

  • course_status_label - Course status label ('Not Started', 'In Progress', 'Completed' )

  • course_steps_completed - Course steps completed

  • course_steps_total - Course steps total

  • course_students_number - Number of Course Students.

  • course_topics - List of all Course Lessons Topics

  • course_topics_number - Number of Course Topics.