Quiz
For loop type learndash_quiz
, here are the query parameters and fields.
Query parameters
all_quizzes
- Whether to return all quizzes(eg. for a Course ID to return all Course, Lessons and Topics quizzes
Type: booleanauthor
- Include by author ID, login name, or 'current'
Type: array, stringcategory
- Include by category ID, slug, or 'current'
Type: array, stringcertificate_earned
- Quiz Certificate earned or not
Type: booleanchild_terms
- Set 'true' to include child terms for hierarchical taxonomies
Type: stringcourse
- Course ID or "current" for current course
Type: stringcustom_date_field
- Filter by given custom date field - Faster than using 'field', this queries raw field values in the database
Type: stringcustom_date_field_compare
- Compare using one of: 'equal' (default), 'not', 'before', 'before_inclusive', 'after', 'after_inclusive'
Type: stringcustom_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: stringcustom_date_field_type
- For custom date field query, one of: date (default), time, datetime, number
Type: stringcustom_date_field_value
- Filter by given custom date field value, or 'current'
Type: stringcustom_field
- Filter by given custom field - Faster than using 'field', this queries raw field values in the database
Type: stringcustom_field_2
- See attribute 'custom_field'
Type: stringcustom_field_3
- See attribute 'custom_field'
Type: stringcustom_field_compare
- Compare using one of: 'equal' (default), 'not', 'before', 'before_inclusive', 'after', 'after_inclusive'
Type: stringcustom_field_compare_2
- See attribute 'custom_field_compare'
Type: stringcustom_field_type
- For custom field query, one of: string (default), number, date, time, datetime
Type: stringcustom_field_type_2
- See attribute 'custom_field_type'
Type: stringcustom_field_type_3
- See attribute 'custom_field_type'
Type: stringcustom_field_value
- Filter by given custom field value
Type: stringcustom_field_value_2
- See attribute 'custom_field_value'
Type: stringcustom_field_value_3
- See attribute 'custom_field_value'
Type: stringenrolled
- Current user is enrolled
Type: booleanexclude
- Exclude by ID or name
Type: string, arrayexclude_author
- Exclude by author ID, login name, or 'current'
Type: string, arrayexclude_category
- Exclude by category ID, slug, or 'current'
Type: string, arrayexclude_parent
- Exclude by parent ID or name
Type: string, arrayexclude_tag
- Exclude by tag ID, slug, or 'current'
Type: string, arrayhas_certificate
- Whether the Quiz has certificate, true/false
Type: booleanhas_prerequisite
- Whether the Quiz has prerequisite, true/false
Type: booleanid
- ID
Type: string, arrayignore_sticky_posts
- Ignore sticky posts
Type: string, array - Default: TRUEinclude
- Include by ID or name
Type: string, arrayinclude_children
- Include children
Type: booleanlesson
- Lesson ID or "current" for current lesson
Type: stringname
- Name/slug
Type: string, arrayorder
- Order: asc (ascending) or desc (descending)
Type: string - Default: ascorderby
- Order by one of: id, author, title, name, type, date, modified, random, comment_count, relevance, menu
Type: string - Default: titleorderby_field
- Order by custom field
Type: stringorderby_field_number
- Order by custom field whose value is a number
Type: stringpage
- Page number
Type: number - Default: 1paged
- Posts per page
Type: number - Default: -1parent
- Include by parent ID or name
Type: string, arraypublish_compare
- Publish date comparison - One of: 'before', 'before_inclusive', 'after', 'after_inclusive'
Type: stringpublish_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: stringpublish_day
- Filter by given publish day of the month, from 1 to 31, or 'current'
Type: numberpublish_month
- Filter by given publish month, from 1 to 12, or 'current'
Type: numberpublish_week
- Filter by given publish week, from 1 to 54, or 'current' - Note: the 'publish_compare' attribute is not supported for this field
Type: numberpublish_year
- Filter by given publish year, or 'current'
Type: numberquiz_status
- Quiz Status for the User: 'completed', 'started', 'locked', 'open'
Type: string, arraysearch
- Search by given keyword - Prepending a keyword with a hyphen '-' will exclude posts matching it
Type: stringstatus
- Post status: publish (default), pending, draft, future, private, trash
Type: string, array - Default: publishstudent
- Student ID or "current" who has quiz started
Type: stringtag
- Include by tag ID, slug, or 'current'
Type: string, arraytaxonomy
- Include by taxonomy ID, slug, or 'current' for taxonomy archive. Use with 'term' and 'taxonomy_compare' attributes
Type: string, numbertaxonomy_2
- See attribute 'taxonomy'
Type: string, numbertaxonomy_3
- See attribute 'taxonomy'
Type: string, numbertaxonomy_compare
- One of 'in' (default), 'not', 'and', 'exists', and 'not exists'. Use with 'taxonomy' attribute
Type: stringtaxonomy_compare_2
- See attribute 'taxonomy_compare'
Type: stringtaxonomy_compare_3
- See attribute 'taxonomy_compare'
Type: stringtaxonomy_relation
- When using more than one 'taxonomy' queries, can specify 'and' or 'or'
Type: stringterms
- Include by taxonomy term ID, slug, or 'current'.Use with 'taxonomy' attribute
Type: string, array, numberterms_2
- See attribute 'terms'
Type: string, array, numberterms_3
- See attribute 'terms'
Type: string, array, numbertopic
- Topic ID or "current" for current topic
Type: stringtype
- Post type(s)
Type: string, array - Default: post
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 downarchive_author
- On an author archive page: Current author as a user looparchive_post_type
- On a post type archive page: Current post type as a looparchive_term
- On a taxonomy archive page: Current taxonomy term as a loopauthor
- Authorauthor_*
- Author's user fieldchildren
- Childrenchildren_ids
- Children IDscontent
- Contentedit_url
- Edit URLexcerpt
- Excerptid
- IDimage
- Featured imageimage_*
- Featured image fieldmenu_order
- Menu ordermodify_date
- Modify datename
- name/slugparent
- Parentparent_*
- Parent fieldparent_ids
- All parent IDs from current to toppost_class
- Post classespublish_date
- Publish datequiz_anker_box
- Renders Quiz Anchor tag Boxquiz_answer_feedback_enabled
- Custom Answer Feedback enabled - "true" or "false"quiz_autostart
- Quiz autostart - "true" or "false"quiz_certificate_data
- Quiz Certificate data loopquiz_certificate_id
- Quiz Certificate IDquiz_certificate_threshold_decimal
- Score needed to receive a certificate - decimal numberquiz_certificate_threshold_percent
- Score needed to receive a certificate - percentagequiz_certificate_url
- Quiz Certificate URLquiz_custom_fields_activated
- Quiz Custom fields Form activated - "true" or "false"quiz_custom_form
- Renders Quiz Custom fields Formquiz_custom_form_position
- Custom Form position - '0'- On the quiz startpage, '1'- At the end of the quiz (before the quiz result)quiz_disable_answer_mark
- Correct / Incorrect Answer Marks disabled - "true" or "false"quiz_display_all
- Renders the Whole Quizquiz_force_question_complete
- Quiz Questions required to complete - "true" or "false"quiz_has_certificate
- Quiz has Certificate - "true" or "false"quiz_has_prerequisite
- Quiz prerequisite set - "true" or "false"quiz_hide_answer_message_box
- Correct / Incorrect Messages hidden - "true" or "false"quiz_hide_correct_questions
- Hide number of correctly answered Questions on the Result page - "true" or "false"quiz_hide_result_points
- Hide achieved Quiz score on the Result page - "true" or "false"quiz_hide_result_time
- Hide Quiz Time on the Result page - "true" or "false"quiz_hide_view_question
- View Questions Button hidden - "true" or "false"quiz_info_page_box
- Renders Quiz Info Page Boxquiz_load_box
- Renders Quiz Loading Boxquiz_lock_box
- Renders Quiz Locked Box(already completed the quiz before)quiz_materials
- Quiz materialsquiz_next_step_id
- Next step Idquiz_next_step_title
- Next step titlequiz_next_step_url
- Next step URLquiz_only_registered_box
- Renders Quiz Only Registered User Boxquiz_only_registered_users
- Only authenticated users can take the Quiz - "true" or "false"quiz_parent_course_id
- Parent Course Idquiz_parent_course_title
- Parent Course Titlequiz_parent_course_url
- Parent Course URLquiz_parent_lesson_id
- Parent lesson Idquiz_parent_lesson_title
- Parent lesson Titlequiz_parent_lesson_url
- Parent lesson URLquiz_parent_topic_id
- Parent topic Idquiz_parent_topic_title
- Parent topic Titlequiz_parent_topic_url
- Parent topic URLquiz_passing_percentage
- Quiz Passing Score/Percentagequiz_prerequisite_box
- Renders Quiz Prerequisite Boxquiz_prerequisites
- Quizzes that must be completed prior to taking the quizquiz_prev_step_id
- Previous step IDquiz_prev_step_title
- Previous step titlequiz_prev_step_url
- Previous step URLquiz_question_answer_random
- Quiz Additional Question Options : Random answers order- "true" or "false"quiz_question_display_single_feedback
- Quiz question feedback display. end = Display results at the end only (default), each = Display results after each submitted answerquiz_question_display_single_feedback_back_button
- Quiz question feedback button display - empty or "on"quiz_question_display_type
- Quiz questions display type. "single": one questionat a time or "multiple": all questions at oncequiz_question_hide_numbering
- Quiz Additional Question Options : Hide Question numbering- "true" or "false"quiz_question_numbered_answer
- Quiz Additional Question Options : Numbered answers- "true" or "false"quiz_question_show_category
- Quiz Additional Question Options : Show category - "true" or "false"quiz_question_show_points
- Quiz Additional Question Options : Show points - "true" or "false"quiz_restart_quiz_hidden
- Restart Quiz button - "true" or "false"quiz_result_grade_enabled
- Quiz Result Messages enabled - "true" or "false"quiz_result_messages
- Quiz Result Messages display - list loop of "percent"/"text" pairsquiz_retries_applicable_to
- Quiz Retries Applicable to: '1'- All users, '2'- Registered only, '3' - Anonymous onlyquiz_retry_repeats
- Number of Retries Allowed - default "0" for unlimitedquiz_retry_restrictions
- Quiz retakes restricted - "true" or "false"quiz_show_add_toplist_box
- Renders Quiz Add to Toplist Boxquiz_show_average_result
- Display the average score of all users who took the quiz - "true" or "false"quiz_show_category_score
- Display the score achieved for each Question Category - "true" or "false"quiz_show_check_page_box
- Renders Quiz Summary Boxquiz_show_max_question
- Renders Quiz all/subset Questions Boxquiz_show_quiz_box
- Renders Quiz Content Boxquiz_show_result_box
- Renders Quiz Results Boxquiz_show_review_box
- Renders Quiz Review Boxquiz_show_review_question
- Quiz show review question table - "true" or "false"quiz_skip_question_disabled
- Quiz Skip question button a disabled - "true" or "false"quiz_start_box
- Renders Quiz Start Boxquiz_status
- Quiz status - "completed, started, locked, open"quiz_status_label
- Quiz status label: Not Started, In Progress, Completed, or Lockedquiz_step_number_course
- Quiz Step Number relative to Coursequiz_step_number_lesson
- Quiz Step Number relative to parent Lessonquiz_step_number_topic
- Quiz Step Number relative to parent Topicquiz_submitted_essays
- Submitted Essays loopquiz_summary_hide
- Quiz Summary table before submission hidden - "true" or "false"quiz_time_limit
- Quiz Time Limit in secondsquiz_time_limit_box
- Renders Quiz Time Limit Boxquiz_time_limit_enabled
- Quiz time limit enabled - "true" or "false"quiz_toplist_access
- Who can apply to Quiz Leaderboard - '1'- All users, '2'- Registered only, '3' - Anonymous onlyquiz_toplist_activated
- Quiz Leaderboard activated - "true" or "false"quiz_toplist_auto_add
- Quiz Leaderboard Automatic user entry - "true" or "false"quiz_toplist_display_enabled
- Quiz Leaderboard Display on Quiz results page enabled - "true" or "false"quiz_toplist_display_limit
- Quiz Leaderboard Number of displayed entries - default '0' for allquiz_toplist_display_position
- Quiz Leaderboard Display on Quiz results page position - '1'- Below the result text, '2'- In a buttonquiz_toplist_in_button_box
- Renders Quiz In Button position Boxquiz_toplist_multi_apply
- Quiz Leaderboard Multiple Applications per user enabled - "true" or "false"quiz_toplist_re_apply
- Quiz Leaderboard Re-apply after - in minutesquiz_toplist_sort_by
- Quiz Leaderboard Sort list by - '1'- Best user, '2'- Newest entry, '3' - Oldest entryquiz_wrap_close
- Renders Quiz Wrapper Close tag - needed for quiz to functionquiz_wrap_open
- Renders Quiz Wrapper Open tag - needed for quiz to functionstatus
- Statustitle
- Titleurl
- URL