Access Plan loop
For loop type lifter_access_plan
, here are the available query arguments and fields.
Query arguments
-
author
- Include by author ID, login name, or "current"Type: string, array
-
can_expire
- Determine if the access plan has expiration settings, true/falseType: boolean
-
category
- Include by category ID, slug, or "current"Type: string, array
-
child_terms
- Set "true" to include child terms for hierarchical taxonomiesType: string
-
custom_date_field
- Filter by given custom date field - Faster than using "field", this queries raw field values in the databaseType: 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, numberType: 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 databaseType: 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, datetimeType: 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 valueType: 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 nameType: 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 nameType: string, array
-
exclude_tag
- Exclude by tag ID, slug, or "current"Type: string, array
-
fields
- -
has_membership
- If plan is associate to a membership, true/falseType: boolean
-
has_restrictions
- Determine if the plan has availability restrictions, true/falseType: boolean
-
has_trial
- Determine if the plan has a trial offer, true/falseType: boolean
-
id
- IDType: string, array
-
ignore_sticky_posts
- Ignore sticky postsDefault:
TRUE
Type: boolean -
include
- Include by ID or nameType: string, array
-
include_children
- Include childrenType: boolean
-
is_available_to_user
- Determine if the plan is available to a user based on configured availability restrictions, true/falseType: boolean
-
is_featured
- Determine if the plan is marked as "featured", true/falseType: boolean
-
is_free
- Determines if a plan is marked as free, true/falseType: boolean
-
is_on_sale
- Determine if a plan is *currently* on sale, true/falseType: boolean
-
is_recurring
- Determine if the Access Plan has recurring payments, true/falseType: boolean
-
is_visible
- Determine if the plan is visible, true/falseType: boolean
-
name
- Name/slugType: 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, menuDefault:
title
Type: string -
orderby_field
- Order by custom fieldType: string
-
orderby_field_number
- Order by custom field whose value is a numberType: string
-
page
- Page numberDefault:
1
Type: number -
paged
- Posts per pageDefault:
-1
Type: number -
parent
- Include by parent ID or nameType: string, array
-
product
- Product ID or "current" for current product where the plan is assigned. Both Courses and Memberships are sellable and can be instantiated as a productType: 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" attributeType: 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 fieldType: 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 itType: string
-
status
- Post status: publish (default), pending, draft, future, private, trashDefault:
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" attributesType: 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" attributeType: 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" attributeType: 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
-
access_expiration
- Access expiration
-
checkout_url
- Return the url to the checkout page for a given plan
-
enroll_text
- Return the enroll text of a given plan
-
expiration_details
- A sentence explaining plan expiration details
-
frequency
- Return the frequecy of a given plan
-
has_availability_restrictions
- If the plan has availability restrictions
-
has_free_checkout
- If the free checkout process & interface should be used for this access plan
-
has_trial
- If the plan has a trial offer
-
is_available_to_user
- If the plan is available to a user based on configured availability restrictions
-
is_featured
- If the plan is marked as "featured"
-
is_on_sale
- If the plan is *currently* on sale, string "true"/"false"
-
is_recurring
- If the plan has recurring payments
-
is_visible
- If the plan is visible
-
price
- Return the price of a given plan (with the currency)
-
price_number
- Return the price of a given plan
-
price_sale
- Return the price on sale of a given plan
-
product_id
- Product ID where the plan is assigned. Both Courses and Memberships are sellable and can be instantiated as a product
-
sale_end
- Date when the sale pricing ends
-
sale_start
- Date when the sale pricing begins
-
schedule_details
- A sentence explaining the plan's trial offer
-
sku
- User-created plan identifier
-
visibility
- Get the access plans visibility setting