Skip to main content

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: boolean

  • certificate_earned - Quiz Certificate earned or not
    Type: boolean

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

  • enrolled - Current user is enrolled
    Type: boolean

  • has_certificate - Whether the Quiz has certificate, true/false
    Type: boolean

  • has_prerequisite - Whether the Quiz has prerequisite, true/false
    Type: boolean

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

  • quiz_status - Quiz Status for the User: 'completed', 'started', 'locked', 'open'
    Type: string, array

  • student - Student ID or "current" who has quiz started
    Type: string

  • topic - Topic ID or "current" for current topic
    Type: string

Fields

  • quiz_anker_box - Renders Quiz Anchor tag Box

  • quiz_answer_feedback_enabled - Custom Answer Feedback enabled - "true" or "false"

  • quiz_autostart - Quiz autostart - "true" or "false"

  • quiz_certificate_data - Quiz Certificate data loop

  • quiz_certificate_id - Quiz Certificate ID

  • quiz_certificate_threshold_decimal - Score needed to receive a certificate - decimal number

  • quiz_certificate_threshold_percent - Score needed to receive a certificate - percentage

  • quiz_certificate_url - Quiz Certificate URL

  • quiz_custom_fields_activated - Quiz Custom fields Form activated - "true" or "false"

  • quiz_custom_form - Renders Quiz Custom fields Form

  • quiz_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 Quiz

  • quiz_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 Box

  • quiz_load_box - Renders Quiz Loading Box

  • quiz_lock_box - Renders Quiz Locked Box(already completed the quiz before)

  • quiz_materials - Quiz materials

  • quiz_next_step_id - Next step Id

  • quiz_next_step_title - Next step title

  • quiz_next_step_url - Next step URL

  • quiz_only_registered_box - Renders Quiz Only Registered User Box

  • quiz_only_registered_users - Only authenticated users can take the Quiz - "true" or "false"

  • quiz_parent_course_id - Parent Course Id

  • quiz_parent_course_title - Parent Course Title

  • quiz_parent_course_url - Parent Course URL

  • quiz_parent_lesson_id - Parent lesson Id

  • quiz_parent_lesson_title - Parent lesson Title

  • quiz_parent_lesson_url - Parent lesson URL

  • quiz_parent_topic_id - Parent topic Id

  • quiz_parent_topic_title - Parent topic Title

  • quiz_parent_topic_url - Parent topic URL

  • quiz_passing_percentage - Quiz Passing Score/Percentage

  • quiz_prerequisite_box - Renders Quiz Prerequisite Box

  • quiz_prerequisites - Quizzes that must be completed prior to taking the quiz

  • quiz_prev_step_id - Previous step ID

  • quiz_prev_step_title - Previous step title

  • quiz_prev_step_url - Previous step URL

  • quiz_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 answer

  • quiz_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 once

  • quiz_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" pairs

  • quiz_retries_applicable_to - Quiz Retries Applicable to: '1'- All users, '2'- Registered only, '3' - Anonymous only

  • quiz_retry_repeats - Number of Retries Allowed - default "0" for unlimited

  • quiz_retry_restrictions - Quiz retakes restricted - "true" or "false"

  • quiz_show_add_toplist_box - Renders Quiz Add to Toplist Box

  • quiz_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 Box

  • quiz_show_max_question - Renders Quiz all/subset Questions Box

  • quiz_show_quiz_box - Renders Quiz Content Box

  • quiz_show_result_box - Renders Quiz Results Box

  • quiz_show_review_box - Renders Quiz Review Box

  • quiz_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 Box

  • quiz_status - Quiz status - "completed, started, locked, open"

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

  • quiz_step_number_course - Quiz Step Number relative to Course

  • quiz_step_number_lesson - Quiz Step Number relative to parent Lesson

  • quiz_step_number_topic - Quiz Step Number relative to parent Topic

  • quiz_submitted_essays - Submitted Essays loop

  • quiz_summary_hide - Quiz Summary table before submission hidden - "true" or "false"

  • quiz_time_limit - Quiz Time Limit in seconds

  • quiz_time_limit_box - Renders Quiz Time Limit Box

  • quiz_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 only

  • quiz_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 all

  • quiz_toplist_display_position - Quiz Leaderboard Display on Quiz results page position - '1'- Below the result text, '2'- In a button

  • quiz_toplist_in_button_box - Renders Quiz In Button position Box

  • quiz_toplist_multi_apply - Quiz Leaderboard Multiple Applications per user enabled - "true" or "false"

  • quiz_toplist_re_apply - Quiz Leaderboard Re-apply after - in minutes

  • quiz_toplist_sort_by - Quiz Leaderboard Sort list by - '1'- Best user, '2'- Newest entry, '3' - Oldest entry

  • quiz_wrap_close - Renders Quiz Wrapper Close tag - needed for quiz to function

  • quiz_wrap_open - Renders Quiz Wrapper Open tag - needed for quiz to function