Skip to main content

Certificate

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

Query parameters​

  • author - Include by author ID, login name, or 'current'
    Type: array, string

  • category - Include by category ID, slug, or 'current'
    Type: array, string

  • child_terms - Set 'true' to include child terms for hierarchical taxonomies
    Type: string

  • course - Course ID(s) or "current" for current course
    Type: string, array

  • 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

  • earned - Earned certificate, "true"/"false"
    Type: bool

  • 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

  • id - ID
    Type: string, array

  • ignore_sticky_posts - Ignore sticky posts
    Type: string, array - Default: TRUE

  • include - Include by ID or name
    Type: string, array

  • include_children - Include children
    Type: boolean

  • name - Name/slug
    Type: string, array

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

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

  • 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
    Type: number - Default: 1

  • paged - Posts per page
    Type: number - Default: -1

  • 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

  • quiz - Quiz ID(s) or "current" for current quiz
    Type: string, array

  • 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
    Type: string, array - Default: publish

  • 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, array, number

  • terms_2 - See attribute 'terms'
    Type: string, array, number

  • terms_3 - See attribute 'terms'
    Type: string, array, number

  • type - Post type(s)
    Type: string, array - Default: post

  • user - User ID or "current" for current user
    Type: string

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

  • certificate_aggregate_percentage - Displays the total percentage score for all quizzes taken as part of the course - works for course certificates only.

  • certificate_aggregate_points - Displays the total points earned for the course - works for course certificates only.

  • certificate_aggregate_score - Displays the final score received for the course - works for course certificates only.

  • certificate_aggregate_timespent - Displays the total time spent on quizzes for the course as a whole - works for course certificates only.

  • certificate_aggregate_total_points - Displays the total points earned for the course - works for course certificates only.

  • certificate_assigned_to - Certificate assigned to "group/course/quiz"

  • certificate_completed_on - Displays the date the course was completed - works for course certificates only.

  • certificate_course_cert_url - Course certificate url for specified/current user

  • certificate_course_id - Certificate course ID - works for course certificates only.

  • certificate_course_points - Displays the total available points for the course - works for course certificates only.

  • certificate_course_price - Displays the course price (only for one-time payment courses) - works for course certificates only.

  • certificate_course_price_type - Displays the Access Mode for the given course - works for course certificates only.

  • certificate_course_title - Displays the course title - works for course certificates only.

  • certificate_course_url - Displays the course URL - works for course certificates only.

  • certificate_cumulative_percentage - Displays the average percentage of all quizzes taken in the course - works for course certificates only.

  • certificate_cumulative_points - Displays the average points earned - works for course certificates only.

  • certificate_cumulative_score - Displays the average score for all graded parts of the course - works for course certificates only.

  • certificate_cumulative_timespent - Displays the average time spent on each part of the course - works for course certificates only.

  • certificate_cumulative_total_points - Displays the average points earned - works for course certificates only.

  • certificate_earned_date - Certificate earned date

  • certificate_earned_timestamp - Certificate earned timestamp

  • certificate_enrolled_on - Displays the course enrollment date (this does not apply to OPEN courses) - works for course certificates only.

  • certificate_group_cert_url - Group certificate url for specified/current user

  • certificate_group_completed_on - Displays the date the user completed all courses assigned to the group - works for group certificates only

  • certificate_group_courses_count - Displays the number of courses in the group - works for group certificates only

  • certificate_group_enrolled_on - Displays the date the user enrolled into the group - works for group certificates only

  • certificate_group_id - Certificate group ID - works for group certificates only.

  • certificate_group_percent_completed - Displays the score achieved in the group\’s courses - works for group certificates only

  • certificate_group_price - Displays the group's price - works for group certificates only

  • certificate_group_price_type - Displays the group's Access Mode - works for group certificates only

  • certificate_group_title - Displays the group's title - works for group certificates only

  • certificate_group_url - Displays the group's URL - works for group certificates only

  • certificate_group_user_group_status - Displays the group progress status of the user - works for group certificates only

  • certificate_id - Certificate category ID

  • certificate_quiz_cert_url - Quiz certificate url for specified/current user

  • certificate_quiz_count - Displays the number of questions within the quiz - works for quiz certificates only.

  • certificate_quiz_course_id - Displays course id that quiz - works for quiz certificates only.

  • certificate_quiz_course_title - Displays the name of the course that the quiz is associated with - works for quiz certificates only.

  • certificate_quiz_id - Certificate quiz ID - works for quiz certificates only.

  • certificate_quiz_lesson_id - Displays lesson id that quiz - works for quiz certificates only.

  • certificate_quiz_pass - Displays the score required in order to pass the quiz - works for quiz certificates only.

  • certificate_quiz_percentage - Displays the percentage grade received by the user on the quiz - works for quiz certificates only.

  • certificate_quiz_points - Displays the points received by the user on the quiz - works for quiz certificates only.

  • certificate_quiz_pro_quizid - Displays quiz pro id that quiz - works for quiz certificates only.

  • certificate_quiz_score - Displays the score received for that quiz - works for quiz certificates only.

  • certificate_quiz_timespent - Displays the time spent taking the quiz - works for quiz certificates only.

  • certificate_quiz_timestamp - Displays the day/time when the quiz was completed - works for quiz certificates only.

  • certificate_quiz_title - Displays the name of the quiz - works for quiz certificates only.

  • certificate_quiz_topic_id - Displays topic id that quiz - works for quiz certificates only.

  • certificate_quiz_total_points - Displays the total possible points that can be received for a given attempt - works for quiz certificates only.

  • certificate_status - Certificate status, "earned/not-earned"

  • certificate_user_course_points - Displays the amount of points the user earned for the course - works for course certificates only.

  • certificate_user_course_time - Displays the total time spent on a course - works for course certificates only.

  • certificate_user_description - Displays a user's bio

  • certificate_user_display_name - Displays a user's full display name.

  • certificate_user_email - Displays a user's email address

  • certificate_user_first_name - Displays a user's first name

  • certificate_user_id - User ID

  • certificate_user_last_name - Displays a user's last name

  • certificate_user_login - Displays a user's username

  • certificate_user_url - Displays a user's website address

  • 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

  • url - URL