Thrive Themes products come with a set of helpful hooks that allow developers to extend functionality, modify data, and trigger custom logic during specific events. This reference covers all developer-facing hooks across the Thrive product suite.
How to Use Hooks
Action hooks let you run custom code when a specific event occurs. Use add_action() to attach your function:
Add your custom hooks in a child theme’s functions.php or in a site-specific plugin. Always prefix your function names (e.g., mycompany_) to avoid conflicts.
Fires for every accepted form submission, whatever the form is connected to: an email service, a webhook or Thrive Actions
thrive_core_lead_signup
action
$form_data, $user_details
Fires when a subscriber is added through an API connection, once for each connection that accepts them
tcb_api_form_submit
action
$post (array)
Fires before API form submission
tcb_contact_form_user_mail_after_send
action
(none)
Fires after contact form email is sent
tcb_before_api_subscribe_data
filter
$data (array)
Modify form data before subscription processing
tcb_api_subscribe_data
filter
$data (array)
Modify subscription data before sending to CRM
tcb_api_subscribe_data_instance
filter
$data (array)
Modify data for a specific CRM connection instance
tcb_api_subscribe_connections
filter
$connections (array)
Filter available CRM connections for a form
tcb_parse_lead_gen_form_data
filter
$data (array)
Customize lead generation form data structure
tcb_lead_generation_apis_with_tag_support
filter
$apis (array)
Filter CRM APIs that support tags
tcb_spam_prevention_tools
filter
$tools (array)
Register custom spam prevention tools
tcb_post_login_actions
filter
$actions (array)
Customize available post-login actions
tcb_post_register_actions
filter
$actions (array)
Customize available post-registration actions
Which form hook to use: use thrivethemes_form_submitted to run code for every form submission. Use thrive_core_lead_signup only when you need to know that a subscriber was added to an email list. A form whose only connection is a webhook or a Thrive Action never fires thrive_core_lead_signup.
Example — Run code when a subscriber is added to a list:
add_action( 'thrive_core_lead_signup', function( $form_data, $user_details ) {
// Fires once for each API connection that accepted the subscriber
// $form_data['form_data'] holds the submitted fields
error_log( 'New subscriber: ' . $form_data['form_data']['email'] );
}, 10, 2 );
Campaign impression recorded (non-crawler traffic)
thrive_ult_can_display_campaign
filter
$can_display (bool)
Control whether campaigns should display
thrive_ult_js_localize
filter
$frontend_data (array)
Filter frontend JavaScript localization data
Example — Sync campaign start with external system:
add_action( 'thrive_ultimatum_evergreen_campaign_start', function( $campaign, $user ) {
// $campaign contains campaign ID, end time, etc.
// Sync countdown with your email platform
}, 10, 2 );
Display Control
Hook
Type
Parameters
Description
tve_ult_body_end_html
filter
$html (string)
Append custom HTML before closing body tag
tve_ultimatum_ajax_load_forms
filter
$response (array)
Filter AJAX response for lazy-loaded campaigns
tve_ult_shortcode_render_exception
filter
$exception (bool)
Bypass shortcode render exception handling
tve_ult_settings_post_types_blacklist
filter
$blacklist (array)
Blacklist post types from campaign targeting
tve_ult_accepted_admin_pages
filter
$pages (array)
Define which admin pages display Ultimatum UI
Thrive Ovation
Testimonial Lifecycle
Hook
Type
Parameters
Description
thrive_ovation_testimonial_submit
action
$testimonial_details, $user
Testimonial submitted by user
thrive_ovation_testimonial_ready
action
$testimonial_details, $user_details
Testimonial approved and ready for display
thrive_ovation_testimonial_rejected
action
$testimonial_details, $user_details
Testimonial rejected by admin
Example — Notify on testimonial approval:
add_action( 'thrive_ovation_testimonial_ready', function( $testimonial, $user ) {
// Send thank-you email or publish to social media
wp_mail( $user['email'], 'Your testimonial is live!', 'Thank you for your feedback.' );
}, 10, 2 );
Thrive Automator
Initialization and Data Objects
Hook
Type
Parameters
Description
thrive_automator_init
action
(none)
Fires after Thrive Automator initializes — register custom triggers here
thrive_automator_process_data_object_{id}
filter
$data_object, $raw_data, $data_object_id
Modify specific data object types before automation triggers
thrive_automator_data_object_{id}_fields
filter
$fields (array)
Modify available fields on a data object type
thrive_automator_filter_duplicate_meta
filter
$meta, $new_id, $old_id
Filter post meta when duplicating an automation
Parameter Reference
Common Parameter Shapes
$user_details (array) — Used across Apprentice lifecycle hooks:
For thrive_core_lead_signup, these fields sit under $form_data['form_data'].
$payload (array) — thrivethemes_form_submitted:
user_id — Current user ID (0 for visitors who aren’t logged in)
form_data — Submitted form fields
source — architect or leads
source_url — URL of the page where the form was submitted
post_id — ID of the post or page where the form was submitted
timestamp — Unix timestamp
Best Practices
Use a child theme or custom plugin. Add your custom hooks to a child theme’s functions.php or create a site-specific plugin. Never edit core plugin files directly.
Prefix your functions. Use prefixes like mycompany_ or client_ to avoid naming conflicts with other plugins.
Set priority and parameter count. Always specify the priority (default 10) and the number of accepted parameters when hooking into actions and filters. For example: add_action( 'hook_name', 'my_function', 10, 2 ).
Return filtered values. When using add_filter(), always return a value. Forgetting to return will result in null data.
Test in staging first. Always test your custom hooks on a staging site before deploying to production.
Sequence rules uses cookies to track the order of requests a user has made and the time between requests and makes them available via Cloudflare Rules. This allows you to write rules that match valid or invalid sequences. The specific cookies used to validate sequences are called sequence cookies.
session
cf_ob_info
The cf_ob_info cookie provides information on: The HTTP Status Code returned by the origin web server. The Ray ID of the original failed request. The data center serving the traffic
session
cf_clearance
Whether a CAPTCHA or Javascript challenge has been solved.
session
_cfuvid
The _cfuvid cookie is only set when a site uses this option in a Rate Limiting Rule, and is only used to allow the Cloudflare WAF to distinguish individual users who share the same IP address.
session
__cflb
When enabling session affinity with Cloudflare Load Balancer, Cloudflare sets a __cflb cookie with a unique value on the first response to the requesting client. Cloudflare routes future requests to the same origin, optimizing network resource usage. In the event of a failover, Cloudflare sets a new __cflb cookie to direct future requests to the failover pool.
session
__cf_bm
Cloudflare's bot products identify and mitigate automated traffic to protect your site from bad bots. Cloudflare places the __cf_bm cookie on End User devices that access Customer sites that are protected by Bot Management or Bot Fight Mode. The __cf_bm cookie is necessary for the proper functioning of these bot solutions.
session
__cfruid
Used by the content network, Cloudflare, to identify trusted web traffic.
session
cf_chl_rc_m
These cookies are for internal use which allows Cloudflare to identify production issues on clients.
session
cf_chl_rc_ni
These cookies are for internal use which allows Cloudflare to identify production issues on clients.
session
cf_chl_rc_i
These cookies are for internal use which allows Cloudflare to identify production issues on clients.
session
__cfwaitingroom
The __cfwaitingroom cookie is only used to track visitors that access a waiting room enabled host and path combination for a zone. Visitors using a browser that does not accept cookies cannot visit the host and path combination while the waiting room is active.
session
cf_use_ob
The cf_use_ob cookie informs Cloudflare to fetch the requested resource from the Always Online cache on the designated port. Applicable values are: 0, 80, and 443. The cf_ob_info and cf_use_ob cookies are persistent cookies that expire after 30 seconds.
session
These cookies are needed for adding comments on this website.
Name
Description
Duration
comment_author_url
Used to track the user across multiple sessions.
Session
comment_author_email
Used to track the user across multiple sessions.
Session
comment_author
Used to track the user across multiple sessions.
Session
Easy Digital Downloads is a WordPress plugin for selling digital products effortlessly and managing transactions.
Name
Description
Duration
edd_items_in_cart
Stores information about the cart contents.
Session
edd_session_
Stores information about the current user session.
Session
Google's current Sign in with Google client library. It renders the Google sign-in button, or the One Tap prompt, so visitors can log in to your site with their Google account. It replaces the older Google Sign-In platform library.
Set on your own domain by the Sign in with Google client library and submitted together with the sign-in credential, so your site can confirm the sign-in came from its own page and not from a forged cross-site request.
5 minutes
g_state
Set on your own domain by the Sign in with Google client library. Records whether the visitor has dismissed the One Tap sign-in prompt and for how long it should stay hidden, plus the time the library last loaded and a browsing session id used for the same purpose. Sites that pass a custom state_cookie_name will see that name instead.
180 days
These cookies are used for managing login functionality on this website.
Name
Description
Duration
wordpress_test_cookie
Used to determine if cookies are enabled.
Session
wordpress_sec
Used to track the user across multiple sessions.
15 days
wordpress_logged_in
Used to store logged-in users.
Persistent
Stripe is a payment processing platform that enables businesses to accept online payments securely and efficiently.
Set by payment provider stripe.com to process payments
10 years
__stripe_sid
Fraud prevention and detection
30 minutes
__stripe_mid
Fraud prevention and detection
1 year
Thrive Apprentice is a powerful learning management system for creating and selling online courses seamlessly.
Name
Description
Duration
tve_learned_lessons
Used to mark learned lessons from each course and to build the progress bar widget from the sidebar, if used.
1 year
tva_conversions
Holds each conversion from every single lesson.
1 year
tva_comment_cookie_{comment_id}
Used to display various data regarding a comment, if it is in approval stage.
30 days
tva_cookie_user_name
Used to auto-fill the username, if the user wants to post a comment again.
30 days
tva_cookie_user_email
Used to auto-fill the email, if the user wants to post a comment again.
30 days
tva_cookie_user_url
Used to auto-fill the website URL, if the user wants to post a comment again.
30 days
tva_lesson_to_redirect
Stores the lesson from the user that has been redirected on Thrive Apprentice login page.
After successful login, the user will be redirected to that lesson.
Session
Thrive Comments enhances engagement with insightful comment management and moderation tools for online communities.
Name
Description
Duration
tve_secret
Used to prevent comment spam.
1 year
social-login
Stores the information from a successfully logged user using social media platforms.
Session
tcm_commenter_first
Used to retain the fact that the user has commented once in the current session.
30 mins
tcm_cookie_{comment_id}
So that the user can see his/her comment even if it’s not approved.
30 days
tcm_cookie_user_name
Used to prefill form inputs.
Session
tcm_cookie_user_email
Used to prefill form inputs.
Session
tcm_cookie_user_website
Used to prefill form inputs.
Session
tcm_commenters
Used to keep count of how many times a user has commented on a specific post.
30 mins
vote-comment-{comment_id}
Used to keep count of what type of vote a certain user gave
365 days
Create engaging quizzes with Thrive Quiz Builder to enhance user interaction and boost lead generation.
Name
Description
Duration
tqb-impression-{page_id}
Flag if impression exists.
30 days
tqb-impression-{page_id}-{user_unique_id}
Unique cookie for each user (used for unique visits).
30 days
tqb-conversion-{page_id}
Flag if conversion exists.
30 days
tqb-conversion-{page_id}-{user_unique_id}
Unique cookie for each user (used for unique conversion)
Contains information related to marketing campaigns of the user. These are shared with Google AdWords / Google Ads when the Google Ads and Google Analytics accounts are linked together.
90 days
__utmx
Used to determine whether a user is included in an A / B or Multivariate test.
18 months
_gali
Used by Google Analytics to determine which links on a page are being clicked
30 seconds
_ga_
ID used to identify users
2 years
_ga
Used to distinguish users.
2 years
_gat
Used to throttle request rate.
1 minute
_gid
Used to distinguish users.
24 hours
__utma
Used to distinguish users.
Persistent
__utmb
Used to determine new sessions/visits.
30 minutes
__utmc
Used to determine if the user is in a new session/visit.
Session
__utmt
Used to throttle request rate.
10 minutes
__utmv
Used to store visitor-level custom variable data.
2 years
__utmz
Stores the traffic source or campaign that explains how the user reached your site.
6 months
Marketing cookies are used to follow visitors to websites. The intention is to show ads that are relevant and engaging to the individual user.
Name
Description
Duration
affwp_campaign
Stores the affiliate campaign name for tracking purposes.
30 days
affwp_ref_visit_id
Stores the visit ID linked to the referring affiliate.
30 days
affwp_ref
Stores the referring affiliate ID for commission attribution.
30 days
Facebook Pixel is a web analytics service that tracks and reports website traffic.
Google uses cookies for advertising, including serving and rendering ads, personalizing ads (depending on your ad settings at g.co/adsettings), limiting the number of times an ad is shown to a user, muting ads you have chosen to stop seeing, and measuring the effectiveness of ads.
90 Days
FPGCLGB
Google uses cookies for advertising, including serving and rendering ads, personalizing ads (depending on your ad settings at g.co/adsettings), limiting the number of times an ad is shown to a user, muting ads you have chosen to stop seeing, and measuring the effectiveness of ads.
90 Days
_gac_gb_
Google uses cookies for advertising, including serving and rendering ads, personalizing ads (depending on your ad settings at g.co/adsettings), limiting the number of times an ad is shown to a user, muting ads you have chosen to stop seeing, and measuring the effectiveness of ads.
90 Days
_gcl_gb
Google uses cookies for advertising, including serving and rendering ads, personalizing ads (depending on your ad settings at g.co/adsettings), limiting the number of times an ad is shown to a user, muting ads you have chosen to stop seeing, and measuring the effectiveness of ads.
90 Days
_gcl_gs
Google uses cookies for advertising, including serving and rendering ads, personalizing ads (depending on your ad settings at g.co/adsettings), limiting the number of times an ad is shown to a user, muting ads you have chosen to stop seeing, and measuring the effectiveness of ads.
90 Days
_gcl_aw
Google uses cookies for advertising, including serving and rendering ads, personalizing ads (depending on your ad settings at g.co/adsettings), limiting the number of times an ad is shown to a user, muting ads you have chosen to stop seeing, and measuring the effectiveness of ads.
90 Days
Conversion
Google uses cookies for advertising, including serving and rendering ads, personalizing ads (depending on your ad settings at g.co/adsettings), limiting the number of times an ad is shown to a user, muting ads you have chosen to stop seeing, and measuring the effectiveness of ads.
90 days
__Secure-3PSID
Targeting cookie. Used to profile the interests of website visitors and display relevant and personalised Google ads.
2 years
__Secure-1PAPISID
Targeting cookie. Used to create a user profile and display relevant and personalised Google Ads to the user.
2 years
__Secure-1PSIDTS
Targeting cookie. Used to create a user profile and display relevant and personalised Google Ads to the user.
2 years
__Secure-3PSIDTS
Targeting cookie. Used to create a user profile and display relevant and personalised Google Ads to the user.
2 years
__Secure-3PSIDCC
Targeting cookie. Used to create a user profile and display relevant and personalised Google Ads to the user.
2 years
ADS_VISITOR_ID
Cookie required to use the options and on-site web services
2 months
AEC
AEC cookies ensure that requests within a browsing session are made by the user, and not by other sites. These cookies prevent malicious sites from acting on behalf of a user without that user's knowledge.
6 months
__Secure-3PAPISID
Profiles the interests of website visitors to serve relevant and personalised ads through retargeting.
2 years
__Secure-1PSIDCC
Targeting cookie. Used to create a user profile and display relevant and personalised Google Ads to the user.
2 years
__Secure-1PSID
Targeting cookie. Used to create a user profile and display relevant and personalised Google Ads to the user.
2 years
Lindris is an email marketing platform for building subscriber lists, sending campaigns, and automating follow-up emails.
Our Website uses X buttons to allow our visitors to follow our promotional X feeds, and sometimes embed feeds on our Website.
2 years
personalization_id
Unique value with which users can be identified by X. Collected information is used to be personalize X services, including X trends, stories, ads and suggestions.
2 years
guest_id
This cookie is set by X to identify and track the website visitor. Registers if a users is signed in the X platform and collects information about ad preferences.