Coupon loop

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

Query arguments

  • access_plan - Access Plan ID or "current" for current access plan where the coupon is assigned.

    Type: string

  • 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

  • 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

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

  • has_main_discount - Determine if the main (non-trial) price is discounted by the coupon. true/false

    Type: boolean

  • has_remaining_uses - Determine if a coupon has uses remaining. true/false

    Type: boolean

  • has_trial_discount - Determine if trial amount discount is enabled for the coupon. true/false

    Type: boolean

  • 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

  • is_expired - Determine if a coupon is expired. true/false

    Type: boolean

  • 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

  • product - Product ID or "current" for current product where the coupon is assigned.

    Type: string

  • 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

Fields

  • amount - Get coupon amount
  • courses - Coupon courses sub Loop
  • expiration_time - The timestamp of a coupon expiration date
  • formatted_amount - Get the formatted coupon amount with currency symbol and/or percentage symbol
  • formatted_discount_type - Get the discount type for human reading and allow translation
  • has_main_discount - If the main (non-trial) price is discounted by this coupon,"true"/"false"
  • has_remaining_uses - If a coupon has uses remaining,"true"/"false"
  • has_trial_discount - If trial amount discount is enabled for the coupon,"true"/"false"
  • id - Coupon ID
  • is_expired - If a coupon is expired,"true"/"false"
  • memberships - Coupon memberships sub Loop
  • remaining_uses - The number of remaining uses
  • usage_limit - Coupon usage limit
  • uses - The number of times the coupon has been used