Get optin step settings is a WordPress ability from CartFlows — usable via Easy MCP AI, which connects Claude, ChatGPT, and any AI assistant to your site.
Install Free Plugin →Get optin step settings
Read-onlyRead the full configuration of a CartFlows optin (lead-capture) step.
Requires the CartFlows plugin on WordPress 6.9+, since abilities only register when WordPress's Abilities API (wp_register_ability / WP_Ability) is available. Every ability additionally requires the current user to hold the 'cartflows_manage_flows_steps' capability. Flow and step lifecycle abilities (publish, unpublish, clone, trash, restore, update, reorder, clone-step, update-step-title) are further gated by the 'cartflows_abilities_api_edit' site option, while settings, checkout, thank-you, optin, email-report, product-mapping, creation, and template-import abilities are gated by the separate 'cartflows_abilities_api_write' option — both default to enabled but let site admins disable write access independently. WooCommerce must also be active for the analytics, checkout, thank-you, optin, and product-flow-mapping abilities, and for importing flow templates.
What it does
This ability returns an optin step's assigned product (which must be simple, virtual, and free), its submit button text, and its pass-fields settings (whether captured form fields are passed to the next step as URL parameters). Requires WooCommerce. Use it to inspect an optin/lead-capture step before adjusting it.
See it in action
You ask your AI assistant
"Show me the current settings for the optin step 65."
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| step_id | integer | Yes | The optin step ID. |
Returns
An object with step_id, a product object (id, name — must be simple, virtual, and free), button_text, and a pass_fields object (enabled, specific_fields). Requires WooCommerce.
Permission
The current user must have the 'cartflows_manage_flows_steps' capability; this read-only ability has no additional option gate.
More CartFlows abilities
Clone funnel
Duplicate a CartFlows funnel, including all its steps and settings.
Clone step
Duplicate a CartFlows step within the same funnel.
Create funnel
Create a new, empty CartFlows funnel.
Create step
Create a new step and attach it to an existing CartFlows funnel.
Export funnel data
Export one or more CartFlows funnels as structured JSON, including all steps and settings.
Get checkout form fields
Read the billing and shipping field configuration of a CartFlows checkout step.