These variables are only available on their specific pages.
Site Landing Page
The site landing page has access to any of the global variables. When building a site landing page, please take a look at a working example in the basic theme folder "Site Pages/Site Landing Page"
Affiliate Index Page
This is the page where an affiliate can view general affiliate information.
| context | available UNKNOWN |
| Locator | Description |
| page.affiliate_commission_percentage |
Get the user's affiliate commission
|
| page.page_identifier |
{String} The unique identifier for this page
|
Affiliate Links Page
This is the page where an affiliate can view their product links.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.homepage_link |
{String} Get the homepage affiliate's link
|
| page.affiliate_links |
{Hash} Get the affiliate's product links
|
| page.has_affiliate_links |
{Boolean} Does the affiliate have any product links? True or false
|
Affiliate Reports Page
This is the page where an affiliate can view their affiliate data.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.total_commission_owed_in_dollars |
{String} Get the user's total commission that is still owed
|
| page.total_commission_paid_in_dollars |
{String} Get the user's total commission that has been paid
|
| page.commissions |
{Drops::AffiliateCommission} Get the user's comissions
|
| page.payouts |
{Drops::AffiliatePayout} Get the user's payouts
|
| page.visitor_dates |
{Hash} Get the user's visitor dates
|
| page.has_commissions |
{Boolean} Does the user have any comission? True or False
|
| page.has_payouts |
{Boolean} Does the user have any payout? True or False
|
| page.has_visitors |
{Boolean} Has the user had any visitors? True or False
|
Affiliate Links Page
This is the page where an affiliate can edit their affiliate settings.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
Bundle Page
This is the landing page for a bundle. It is used to supply data to any bundle landing page template that you create.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
The unique identifier for this page
|
| page.bundle |
{Drops::Bundle} Get bundle data
|
| page.coupon |
{Drops::Coupon} Get coupon data
|
| page.coupon_code_provided |
{Boolean} Has a coupon code been provided? True or false
|
| page.seo_title |
{String} Get the SEO Title
|
| page.seo_description |
{String} Get the SEO Description
|
| page.keywords |
{String} Get the product's keywords
|
| page.is_hidden |
{Boolean} Is the product hidden? True or false
|
| page.product_is_course |
{Boolean} Is the product a course?
|
| page.product_is_bundle |
{Boolean} Is the product a bundle?
|
| page.product_is_community |
{Boolean} Is the product a community?
|
| page.landing_page_code |
{String} Get the custom landing page code
|
Checkout Page
This is the page that the buyer is shown when making a purchase. Includes the Checkout sign in page and Checkout - payment page.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.checkout_form |
{String} Get checkout form html
|
| page.cart |
{Drops::Cart} The current cart
|
| page.contains_subscription_product |
{Boolean} Does the checkout include a subscription product? True or false
|
| page.course_name |
{String} Get the course name
|
| page.course_price |
{String} Get the course price
|
| page.has_subscription_products |
{Boolean} Does the course have subscription products? True or false. Duplicate of above
|
| page.stripe_checkout_is_allowed |
{Boolean} Is stripe checkout allowed? True or false.
|
| page.checkout_coupons_disabled |
{Boolean} Are coupons on checkout disabled? True or false.
|
| page.header_without_links_required |
{Boolean} Is a header without links required? Defaults to true.
|
| page.product |
{Drops::Product} The product being purchased
|
| page.product_price |
{Drops::ProductPrice} The product price being purchased
|
| page.checkout_description |
{String} The description of what is being purchased
|
Checkout Sign In/Sign Up Page
This is the page that is displayed to an anonymous user as they enter the checkout flow
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
The unique identifier for this page
|
| page.active_tab |
rubocop:disable Style/TrivialAccessors
|
| page.cart |
{Drops::Cart} The current cart
|
| page.product |
{Drops::Product} The product being purchased
|
| page.product_price |
{Drops::ProductPrice} The product prices of the product being purchased
|
| page.checkout_description |
{String} The description of what is being purchased
|
| page.checkout_coupons_disabled |
{Boolean} Are checkout coupons disabled? True or false.
|
| page.header_without_links_required |
{Boolean} Is a header without links required? True or false. Defaults to true.
|
| page.stripe_checkout_is_allowed |
{Boolean} Is stripe checkout allowed? True or false.
|
| page.has_remote_signin |
{Boolean} Does the user have a remote sign-in? True or false
|
| page.has_linkedin_enabled |
{Boolean} Does the user have LinkedIn enabled? True or false
|
| page.has_facebook_enabled |
{Boolean} Does the user have Facebook enabled? True or false
|
| page.has_google_enabled |
{Boolean} Does the user have Google enabled? True or false
|
| page.supports_remote_auth |
{Boolean} Supports remote auth? Always returns false. DEPRECATED (2018/08)
|
| page.linkedin_oauth_url |
{String} User LinkedIn oAuth Url
|
| page.facebook_oauth_url |
{String} User Facebook oAuth Url
|
| page.google_oauth_url |
{String} User Google oAuth Url
|
| page.tenant_oauth_url |
{String} Always returns '' (empty string). DEPRECATED (2018/08)
|
| page.tenant_auth_text |
{String} Always returns '' (empty string). DEPRECATED (2018/08)
|
| page.sign_up_url |
{String} Get the sign-in url
|
| page.forgot_password_url |
{String} Get the forgot password url
|
| page.sign_in_url |
{String} Get the sign-in url
|
| page.social_providers |
{Array} Get enabled social providers for the tenant with the following attributes: oauth_url, class and fa_icon
|
Checkout Thank-you Page
This is the page that the buyer is shown after making a purchase
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.take_course_url |
{String} Get the take course url. DEPRECATED
|
| page.community_url |
{String} Get the community url
|
| page.order_receipt_url |
{String} Get the order-receipt url
|
| page.order |
{Drops::Order} Get order detail
|
| page.items |
{Drops::LineItem} Get a list of items that have been purchased
|
| page.products |
{Drops::Product} Get all cart products
|
| page.course |
{Drops::Course} Get the checkout's course. Returs nil if purchased product is not a course
|
| page.bundle |
{Drops::Bundle} Get the checkout's bundle. Returs nil if purchased product is not a bundle
|
| page.community | {Drops::Community} Get the checkout's community. Returs nil if purchased product is not a community |
| page.product_is_course |
{Boolean} Is the product a course? True or false.
|
| page.product_is_bundle |
{Boolean} Is the product a bundle? True or false.
|
| page.product_is_community |
{Boolean} Is the product a community? True or false.
|
| page.bundled_courses |
{Drops::Course} Get bundled courses
|
| page.has_more_bundled_courses |
{Boolean} Does the purchased course have more bundled items? True or false
|
| page.remaining_bundle_courses_message |
{String} Get the remaining bundle courses message
|
| page.remaining_bundle_items_message |
{String} Get the remaining bundle items message
|
Collection Page
This shows all products in a specific collection/category
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
Collections Page
This page shows all the published courses
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.name |
{String} Get the name of the collection
|
| page.current_collection_id |
{Number} Get the selected collection id
|
| page.current_collection_slug |
{String} get the slug of the collection
|
| page.current_collection_name |
{String} Get the name of the current collection
|
| page.should_paginate_products |
{Boolean} Should the collection be paginated? Returns true if the number of pages in the collection is greater than 1. True or false.
|
| page.product_page_numbers |
{Array} Get available page numbers for pagination of the collection
|
| page.current_product_page |
{Number} Get the current product's page
|
| page.has_products |
{Boolean} Does the collection have products? True or false.
|
| page.products |
{Drops::Product} Get the products to be rendered on the page
|
| page.has_search_query |
{Boolean} Does the page have a search query applied? True or false.
|
| page.search_query |
{String} Get the currently applied search query
|
Community Page
This is the landing page for a community. It is used to supply data to any community landing page template that you create. Requires system theme version 2.7.0 or higher.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.community |
{Drops::Community} Get community data
|
| page.coupon |
{Drops::Coupon} Get coupon data
|
| page.coupon_code_provided |
{Boolean} Has a coupon code been provided? True or false
|
| page.seo_title |
{String} Get the SEO Title
|
| page.seo_description |
{String} Get the SEO Description
|
| page.keywords |
{String} Get the product's keywords
|
| page.is_hidden |
{Boolean} Is the product hidden? True or false
|
| page.product_is_course |
{Boolean} Is the product a course?
|
| page.product_is_bundle |
{Boolean} Is the product a bundle?
|
| page.product_is_community |
{Boolean} Is the product a community?
|
| page.landing_page_code |
{String} Get the custom landing page code
|
Course Landing Page
This is the landing page for a course. It is used to supply data to any course landing page template that you create.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.course |
{Drops::Course} Get course data
|
| page.coupon |
{Drops::Coupon} Get coupon data
|
| page.coupon_code_provided |
{Boolean} Has a coupon code been provided? True or false
|
| page.thinkific_analytics_course_data |
{String} Get the thinkific analyitics course data
|
| page.seo_title |
{String} Get the SEO Title
|
| page.seo_description |
{String} Get the SEO Description
|
| page.keywords |
{String} Get the product's keywords
|
| page.is_hidden |
{Boolean} Is the product hidden? True or false
|
| page.product_is_course |
{Boolean} Is the product a course?
|
| page.product_is_bundle |
{Boolean} Is the product a bundle?
|
| page.product_is_community |
{Boolean} Is the product a community?
|
| page.landing_page_code |
{String} Get the custom landing page code
|
| page.total_video_content_time |
{String} Formatted total hours of video content for the Course. Rounded to the nearest half hour
|
Custom Page
These are the variables available on any custom page that you create
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.content |
{String} Get the content of the page (returns marked up html)
|
| page.name |
{String} Get the name of the page
|
| page.published |
{Boolean} Is the page published? True or false
|
| page.public |
{Boolean} Is the page public? True or false
|
| page.url |
{String} Get the url of the page
|
| page.seo_title |
{String} Get the page's SEO Title
|
| page.seo_description |
{String} Get the page's SEO Description
|
| page.seo_metatags |
{String} Get the page's SEO Metatags
|
| page.keywords |
{String} Get the page's keywords
|
Dashboard Page
This page shows all the published courses that a student is currently enrolled in, but also exposes variables to access all courses within the school
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.status_types |
{Hash} Get the possible enrollment states to populate the status list for searching
|
| page.all_cards |
{Drops::DashboardCourseCard} Get all product cards (cards of any status) that are attached to the student
|
| page.enrolled_cards |
{Drops::DashboardCourseCard} Get all product cards in which the student is enrolled
|
| page.not_enrolled_cards |
{Drops::DashboardCourseCard} Get all product cards attached to the student in which the student is not enrolled
|
| page.current_collection_id |
{Number} Get the current collection id
|
| page.current_collection_name |
{String} Get the current collection name
|
| page.current_collection_slug |
{String} Get the current collection slug
|
| page.communities |
{Drops::Community} Get all communities in which the student has access to
|
| page.has_search_query |
{Boolean} Does the page have a search query applied? True or false.
|
| page.search_query |
{String} Get the currently applied search query
|
Edit Course Review Page
This is the page where a student can review a course. Specifically, this page is where the student edits a review that they've already made.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.course_review |
{Drops::CourseReview} Get the course review data
|
Express Sign In Page
This is the page that your users set their password on
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
Home Page
This is the main landing page of the site. It is shown when someone visits the root url of your site (mysite.thinkific.com/), except when you have only one published course or bundle.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.should_paginate_products |
{Boolean} Should the collection be paginated? Returns true if the number of pages in the collection is greater than 1. True or false.
|
| page.product_page_numbers |
{Array} Get available page numbers for pagination of the collection
|
| page.current_product_page |
{Number} Get the current product's page
|
| page.has_products |
{Boolean} Does the collection have products? True or false.
|
| page.products |
{Drops::Product} Get the products to be rendered on the page
|
My Account Page
This is the page where a student can view and edit their account details.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.timezone_options |
{Hash} Get timezone options
|
| page.site_locale_options |
{Hash} Get locale options
|
| page.has_student_locale_selection_enabled |
{Boolean} Does the student have locale selection enabled? True or False
|
My Account Billings Page
This is the page where a student can view their saved billing information (if any).
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.edit_billings_form |
{String} Get the edit billings form html
|
| page.has_form_errors |
{Boolean} Does the form have errors? True or false
|
| page.form_error_messages |
{Array} Get the form error messages
|
| page.form_error_count |
{Number} Get the form error count
|
My Account Certificates Page
This is the page where a student can view their certificates. Note: This page is only shown if the site owner has the Completion Certificates feature.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.enrollments_with_certificates |
{Drops::Enrollment} Get enrollments with certificates
|
My Account Credit Card Page
This is the page that the student can use to add/modify/delete their credit card
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.my_account_credit_card_form |
{String} Get credit card form html
|
| page.header_without_links_required |
{Boolean} Is a header without links required? Defaults to true.
|
My Account Notifications Page
This is the page where a student can view and edit their notifications settings.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.allow_weekly_email_reminders |
{Boolean} Allow weekly email remainders? True or False
|
| page.allow_discussion_question_answered_email |
{Boolean} Allow discussion question answered email? True or False
|
My Account Order Page
This is the page where a student can view a single order in detail.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.order |
{Drops::Order} Get the order
|
| page.created_date |
Get the date that the order was created on
|
My Account Orders Page
This is the page where a student can view their orders.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.has_orders |
{Boolean} Does the account have any orders? True or false
|
| page.orders |
{Drops::Order} Get the account's orders
|
My Account Password Page
This is the page under 'My Account' where a user can change their password.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
New Course Review Page
This is the page where a student can review a course. Specifically, this page is where the student creates the review in the first place.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.course_review |
{Drops::CourseReview} Get the course review data
|
Password Reset Page
This is the page where a student will land after following the 'change password' link from their email. Here they can change their password.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
Password Reset Request Page
This is the page where a student can request a change of their password
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
Password Reset Sent Page
This is the page where a student will land after requesting a change of password. Displays a message to check their email.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
Paypal Confirm Page
This is the page that a buyer lands on after going through the PayPal Express Checkout process. It is the last step where they must confirm the purchase.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.paypal_confirmation_form |
{String} Get paypal confirmation form html
|
| page.product_display_price |
{String} Get the product's display price
|
| page.product |
{Drops::Product} The product being purchased
|
| page.secure_payment_badge_url |
{String} Get the secure payment badge url
|
Prelaunch Page
This page is shown instead of the homepage if the tenant does not have any published courses yet. It is used to capture email address of new leads.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
Prelaunch Thank You Page
This is the page that a user is shown after they have entered their email address on the Prelaunch Page.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
Sign In Page
This is the page that your users sign in on
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.has_remote_signin |
{Boolean} Does the user have a remote sign-in? True or false
|
| page.has_linkedin_enabled |
{Boolean} Does the user have LinkedIn enabled? True or false
|
| page.has_facebook_enabled |
{Boolean} Does the user have Facebook enabled? True or false
|
| page.has_google_enabled |
{Boolean} Does the user have Google enabled? True or false
|
| page.supports_remote_auth |
{Boolean} Supports remote auth? Always returns false. DEPRECATED (2018/08)
|
| page.linkedin_oauth_url |
{String} User LinkedIn oAuth Url
|
| page.facebook_oauth_url |
{String} User Facebook oAuth Url
|
| page.google_oauth_url |
{String} User Google oAuth Url
|
| page.tenant_oauth_url |
{String} Always returns '' (empty string). DEPRECATED (2018/08)
|
| page.tenant_auth_text |
{String} Always returns '' (empty string). DEPRECATED (2018/08)
|
| page.sign_up_url |
{String} Get the sign-in url
|
| page.forgot_password_url |
{String} Get the forgot password url
|
| page.sign_in_url |
{String} Get the sign-in url
|
| page.social_providers |
{Array} Get enabled social providers for the tenant with the following attributes: oauth_url, class and fa_icon
|
Sign Up Page
This is the page that your users sign up on
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.has_remote_signin |
{Boolean} Does the user have a remote sign-in? True or false
|
| page.has_linkedin_enabled |
{Boolean} Does the user have LinkedIn enabled? True or false
|
| page.has_facebook_enabled |
{Boolean} Does the user have Facebook enabled? True or false
|
| page.has_google_enabled |
{Boolean} Does the user have Google enabled? True or false
|
| page.supports_remote_auth |
{Boolean} Supports remote auth? Always returns false. DEPRECATED (2018/08)
|
| page.linkedin_oauth_url |
{String} User LinkedIn oAuth Url
|
| page.facebook_oauth_url |
{String} User Facebook oAuth Url
|
| page.google_oauth_url |
{String} User Google oAuth Url
|
| page.tenant_oauth_url |
{String} Always returns '' (empty string). DEPRECATED (2018/08)
|
| page.tenant_auth_text |
{String} Always returns '' (empty string). DEPRECATED (2018/08)
|
| page.sign_up_url |
{String} Get the sign-in url
|
| page.forgot_password_url |
{String} Get the forgot password url
|
| page.sign_in_url |
{String} Get the sign-in url
|
| page.social_providers |
{Array} Get enabled social providers for the tenant with the following attributes: oauth_url, class and fa_icon
|
Social Sign Up Page
This is the page that the user will land after authenticating through an external social provider. The user will be redirected here either if the social provider doesn't send us their email or if the site requires custom profile fields or if it has terms and privacy policies to be agreed upon before the registration.
| context | available UNKNOWN |
| Locator | Description |
| page.page_identifier |
{String} The unique identifier for this page
|
| page.requiring_email |
{Boolean} Does the user needs to fill their email
|
| page.has_remote_signin |
{Boolean} Does the user have a remote sign-in? True or false
|
| page.has_linkedin_enabled |
{Boolean} Does the user have LinkedIn enabled? True or false
|
| page.has_facebook_enabled |
{Boolean} Does the user have Facebook enabled? True or false
|
| page.has_google_enabled |
{Boolean} Does the user have Google enabled? True or false
|
| page.supports_remote_auth |
{Boolean} Supports remote auth? Always returns false. DEPRECATED (2018/08)
|
| page.linkedin_oauth_url |
{String} User LinkedIn oAuth Url
|
| page.facebook_oauth_url |
{String} User Facebook oAuth Url
|
| page.google_oauth_url |
{String} User Google oAuth Url
|
| page.tenant_oauth_url |
{String} Always returns '' (empty string). DEPRECATED (2018/08)
|
| page.tenant_auth_text |
{String} Always returns '' (empty string). DEPRECATED (2018/08)
|
| page.sign_up_url |
{String} Get the sign-in url
|
| page.forgot_password_url |
{String} Get the forgot password url
|
| page.sign_in_url |
{String} Get the sign-in url
|
| page.social_providers |
{Array} Get enabled social providers for the tenant with the following attributes: oauth_url, class and fa_icon
|
Student Certificate Page
This is the page used to display a certificate issued to a student for completing an enrollment in a course. Certificates are generated and students are then provided a link to this page in the course player.
| Locator | Description |
| page.certificate_id |
{Number} Get the unique ID that identifies this certificate.
|
| page.course |
{String} Get the name of the course that the student has completed.
|
| page.credential_image_url |
{String} Get the URL to the certificate as an image filetype. (for downloads use the pdf_path)
|
| page.expired |
{Boolean} Whether the certificate has expired or not.
|
| page.expiry_date |
{String} Get the date that the certificate expires.
|
| page.is_certificate_owner |
{Boolean} Whether the current_user is the student that this certificate belongs to.
|
| page.is_preview |
{Boolean} Whether the page being rendered is in preview mode?
|
| page.issue_date |
{String} Get the date that the certificate was issued.
|
| page.pdf_path |
{String} Get the URL to the certificate as a PDF file.
|
| page.student_name |
{String} The name of the student that was issued the certificate.
|
| page.school |
{String} The name of the school that the certificate was issued from.
|