Product loop

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

Query arguments

  • average_rating - Average rating

    Type: number

  • backorders - Backorders allowed

    Type: string

  • count - Limit number of results, or -1 for all

    Default: -1
    Type: number

  • date_created - Date created

    Type: string

  • date_modified - Date modified

    Type: string

  • date_on_sale_from - Date on sale from

    Type: string

  • date_on_sale_to - Date on sale to

    Type: string

  • download_expiry - Download expiry

    Type: number

  • download_limit - Download limit

    Type: number

  • downloadable - Downloadable product

    Type: boolean

  • exclude - Exclude product ID(s)

    Type: array

  • featured - Featured

    Type: boolean

  • height - Height

    Type: number

  • id - Same as include

    Type: array

  • include - Include only product ID(s). This option is overwritten if a membership_id is supplied.

    Type: array

  • length - Length

    Type: number

  • manage_stock - Product stock management enabled/disabled

    Type: boolean

  • membership_id - Return only products which grant access to a specific membership plan. Must have membership plugin installed and activated.

    Type: number

  • order - Order

    Default: desc
    Type: string

  • orderby - Order by field

    Default: name
    Type: string

  • parent - Parent product ID(s)

    Type: number

  • parent_exclude - Exclude parent product ID(s)

    Type: array

  • price - Price

    Type: number

  • product_category - Products by category ID(s), slug(s)

    Type: string, array

  • product_tag - Products by tag ID(s), slug(s)

    Type: string, array

  • product_type - Product type

    Default: ["external","grouped","simple","variable","subscription","variable-subscription","appointment"]
    Type: string, array

  • regular_price - Regular price

    Type: number

  • review_count - Review count

    Type: number

  • reviews_allowed - Reviews allowed

    Type: boolean

  • sale_price - Sale price

    Type: number

  • shipping_class - Shipping class

    Type: string, array

  • sku - Product SKU or partial match

    Type: string

  • sold_individually - Sold individually

    Type: boolean

  • status - Status

    Type: string, array

  • stock_quantity - Stock quantity

    Type: number

  • stock_status - Stock status

    Type: string

  • tag - Products by category slug(s)

    Type: string, array

  • tax_class - Tax status

    Type: string

  • tax_status - Tax status

    Type: string

  • total_sales - Products with total sales

    Type: number

  • virtual - Virtual product (does not require shipping)

    Type: boolean

  • visibility - Product visibility

    Type: string

  • weight - Weight

    Type: number

  • width - Width

    Type: number

Fields

  • attributes - Product attributes if applicable, else empty array
  • availability_span - Availability span
  • average_rating - Average rating
  • backorders - Backorders allowed
  • cancel_limit - Cancel limit value
  • cancel_limit_unit - Cancel limit unit
  • customer_timezones - Customer timezone
  • download_expiry - Download expiry
  • download_limit - Download limit
  • downloadable - Downloadable product
  • duration - Duration value
  • duration_unit - Duration unit
  • expiration_date - The date on which the subscription product will expire
  • featured - Featured
  • first_renewal_payment_date - The first renewal payment will be processed based on the subscription's length
  • grants_access_to_team - Product grants access to a team
  • has_price_label - Has price label
  • has_pricing - Has pricing
  • has_restricted_days - Has restricted days within a week
  • height - Height
  • id - ID
  • interval - Interval value
  • interval_unit - Interval unit
  • length - Returns the length of a subscription product
  • manage_stock - Product stock management enabled/disabled
  • name - Name
  • padding_duration - Padding between slots value
  • padding_duration_unit - Padding between slots unit
  • period - Returns the subscription period for a product
  • price - Price
  • price_label - Price label
  • price_per_period - Returns the active price per period for a product if it is a subscription.
  • price_string - Returns a string representing the details of the subscription.
  • pricing - Pricing,returns list loop
  • purchased - Product is purchased
  • qty - Quantity
  • regular_price - Returns the sale price per period for a product if it is a subscription
  • requires_confirmation - Customer must confirm
  • restricted_days - Restricted days within a week
  • review_count - Review count
  • reviews_allowed - Reviews allowed
  • sale_price - Sale price
  • shipping_class - Shipping class
  • sign_up_fee - The sign-up fee for a subscription
  • sku - Product SKU or partial match
  • sold_individually - Sold individually
  • stock_quantity - Stock quantity
  • stock_status - Stock status
  • subscription_limit - Subscription limitation
  • subscriptions - Active subscription object when restricted to subscription type products
  • tax_class - Tax status
  • tax_status - Tax status
  • total_sales - Products with total sales
  • trial_expiration_date - The date on which the subscription trial will expire
  • trial_length - Returns the trial length of a subscription product
  • trial_period - Returns the trial period of a subscription product
  • type - Product type
  • url - Product URL
  • user_can_cancel - User can cancel
  • variations - Product variations if applicable, else empty array
  • virtual - Virtual product (does not require shipping)
  • visibility - Product visibility
  • weight - Weight
  • width - Width