Product loop

For loop type edd_product, 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

  • category_id - Filter by category term ids

    Type: 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_compare - Compare using one of: "equal" (default), "not", "before", "before_inclusive", "after", "after_inclusive"

    Type: string

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

    Type: string

  • custom_field_value - Filter by given 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 -

  • id - Same as include

    Type: array, integer

  • 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

  • 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 or slug
    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, number

  • taxonomy_compare_2 - See attribute "taxonomy_compare"

    Type: string, number

  • taxonomy_compare_3 - See attribute "taxonomy_compare"

    Type: string, number

  • 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

  • vendor_id - Filter by Vendor id(s)

    Type: array, string

  • vendor_slug - Filter by Vendor slug(s)

    Type: array, 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
  • children - Children
  • children_ids - Children IDs
  • content - Content
  • edit_url - Edit URL
  • excerpt - Excerpt
  • files - Downloadable files. Returns one or more values, depending on whether product has variable prices or not. Returns a Loop.
  • id - ID
  • image - Featured image
  • image_* - Featured image field
  • is_variable - Whether product has variable pricing. If yes, the "pricing" field is to be used to grab price
  • 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
  • price - Product display price (either raw or sale price). Might be irrelevant if product has variable pricing
  • pricing - Product pricing. Returns one or more values, depending on whether product has variable prices or not. Returns a Loop.
  • publish_date - Publish date
  • purchase_link - Edd download purchase link - generates the Purchase or Add to Cart buttons
  • raw_price - Product raw price. Might be irrelevant if product has variable pricing
  • sale_price - Product sale price (whether product is on sale or not). Might be irrelevant if product has variable pricing
  • sku - Product sku
  • status - Status
  • title - Title
  • type - EDD product type
  • url - URL
  • vendor - Product vendor. Returns a Loop of "edd_vendor" type.