Topic loop

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

Query arguments

  • author - Include by author ID, login name, or "current"

    Type: string, array

  • category - Include by category ID, slug, or "current"

    Type: string, array

  • child_terms - Set "true" to include child terms for hierarchical taxonomies

    Type: string

  • completion_status - Topic completion status ('open', 'started', 'completed', 'locked')

    Type: string, array

  • course - Course ID or "current" for current course

    Type: string

  • custom_date_field - Filter by given custom date field - Faster than using "field", this queries raw field values in the database

    Type: string

  • custom_date_field_compare - Compare using one of: "equal" (default), "not", "before", "before_inclusive", "after", "after_inclusive"

    Type: string

  • custom_date_field_format - For custom date field query, specify the date format of the field value - Default is "Ymd"; For date-time field, set "Y-m-d H:i:s". If it's a timestamp, use "timestamp". For custom field plugins other than ACF, you may need to use a different format.

    Type: string

  • custom_date_field_type - For custom date field query, one of: date (default), time, datetime, number

    Type: string

  • custom_date_field_value - Filter by given custom date field value, or "current"

    Type: string

  • custom_field - Filter by given custom field - Faster than using "field", this queries raw field values in the database

    Type: string

  • custom_field_2 - See attribute "custom_field"

    Type: string

  • custom_field_3 - See attribute "custom_field"

    Type: string

  • custom_field_compare - Compare using one of: "equal" (default), "not", "before", "before_inclusive", "after", "after_inclusive"

    Type: string

  • custom_field_compare_2 - See attribute "custom_field_compare"

    Type: string

  • custom_field_compare_3 - See attribute "custom_field_compare"

    Type: string

  • custom_field_type - For custom field query, one of: string (default), number, date, time, datetime

    Type: string

  • custom_field_type_2 - See attribute "custom_field_type"

    Type: string

  • custom_field_type_3 - See attribute "custom_field_type"

    Type: string

  • custom_field_value - Filter by given custom field value

    Type: string

  • custom_field_value_2 - See attribute "custom_field_value"

    Type: string

  • custom_field_value_3 - See attribute "custom_field_value"

    Type: string

  • enrolled - Current user is enrolled

    Type: boolean

  • exclude - Exclude by ID or name

    Type: string, array

  • exclude_author - Exclude by author ID, login name, or "current"

    Type: string, array

  • exclude_category - Exclude by category ID, slug, or "current"

    Type: string, array

  • exclude_parent - Exclude by parent ID or name

    Type: string, array

  • exclude_tag - Exclude by tag ID, slug, or "current"

    Type: string, array

  • fields -

  • id - ID

    Type: string, array

  • ignore_sticky_posts - Ignore sticky posts

    Default: TRUE
    Type: boolean

  • include - Include by ID or name

    Type: string, array

  • include_children - Include children

    Type: boolean

  • lesson - Lesson ID or "current" for current lesson

    Type: string

  • name - Name/slug

    Type: string, array

  • order - Order: asc (ascending) or desc (descending)

    Default: asc
    Type: string

  • orderby - Order by one of: id, author, title, name, type, date, modified, random, comment_count, relevance, menu

    Default: title
    Type: string

  • orderby_field - Order by custom field

    Type: string

  • orderby_field_number - Order by custom field whose value is a number

    Type: string

  • page - Page number

    Default: 1
    Type: number

  • paged - Posts per page

    Default: -1
    Type: number

  • parent - Include by parent ID or name

    Type: string, array

  • publish_compare - Publish date comparison - One of: "before", "before_inclusive", "after", "after_inclusive"

    Type: string

  • publish_date - Filter by publish date in Y-M-D format, "today", "X days ago" and other values compatible with strtotime() - Optionally use "publish_compare" attribute

    Type: string

  • publish_day - Filter by given publish day of the month, from 1 to 31, or "current"

    Type: number

  • publish_month - Filter by given publish month, from 1 to 12, or "current"

    Type: number

  • publish_week - Filter by given publish week, from 1 to 54, or "current" - Note: the "publish_compare" attribute is not supported for this field

    Type: number

  • publish_year - Filter by given publish year, or "current"

    Type: number

  • search - Search by given keyword - Prepending a keyword with a hyphen "-" will exclude posts matching it

    Type: string

  • status - Post status: publish (default), pending, draft, future, private, trash

    Default: publish
    Type: string, array

  • tag - Include by tag ID, slug, or "current"

    Type: string, array

  • taxonomy - Include by taxonomy ID, slug, or "current" for taxonomy archive
    Use with "term" and "taxonomy_compare" attributes

    Type: string, number

  • taxonomy_2 - See attribute "taxonomy"

    Type: string, number

  • taxonomy_3 - See attribute "taxonomy"

    Type: string, number

  • taxonomy_compare - One of "in" (default), "not", "and", "exists", and "not exists"
    Use with "taxonomy" attribute

    Type: string

  • taxonomy_compare_2 - See attribute "taxonomy_compare"

    Type: string

  • taxonomy_compare_3 - See attribute "taxonomy_compare"

    Type: string

  • taxonomy_relation - When using more than one "taxonomy" queries, can specify "and" or "or"

    Type: string

  • terms - Include by taxonomy term ID, slug, or "current"
    Use with "taxonomy" attribute

    Type: string, number, array

  • terms_2 - See attribute "terms"

    Type: string, number, array

  • terms_3 - See attribute "terms"

    Type: string, number, array

  • type - Post type(s)

    Default: post
    Type: string, array

  • video_exists - Topic video exists, true or false

    Type: boolean

Fields

  • all - Show all custom fields (for development purpose)
  • ancestors - Ancestor posts from lowest to highest level; Set reverse=true to go from top-level down
  • archive_author - On an author archive page: Current author as a user loop
  • archive_post_type - On a post type archive page: Current post type as a loop
  • archive_term - On a taxonomy archive page: Current taxonomy term as a loop
  • author - Author
  • author_* - Author's user field
  • children - Children
  • children_ids - Children IDs
  • content - Content
  • edit_url - Edit URL
  • excerpt - Excerpt
  • id - ID
  • image - Featured image
  • image_* - Featured image field
  • menu_order - Menu order
  • modify_date - Modify date
  • name - name/slug
  • parent - Parent
  • parent_* - Parent field
  • parent_ids - All parent IDs from current to top
  • post_class - Post classes
  • publish_date - Publish date
  • status - Status
  • title - Title
  • 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_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.
  • url - URL