File
Filter Name
Description
admin/section/class-convertkit-admin-section-base.php
convertkit_settings_base_register_noticesRegister success and error notices for settings screens.
admin/class-convertkit-admin-settings.php
convertkit_admin_settings_form_methodDefines the settings form's method.
convertkit_admin_settings_form_action_urlDefines the settings form's action URL.
convertkit_plugin_screen_action_linksDefine links to display below the Plugin Name on the WP_List_Table at Plugins > Installed Plugins.
convertkit_admin_settings_register_sectionsRegisters settings sections at Settings > Kit.
admin/class-convertkit-admin-post.php
convertkit_admin_post_register_add_new_buttonsRegisters 'Add New' buttons for the given Post Type's admin screen.
admin/class-convertkit-admin-setup-wizard.php
convertkit_admin_setup_wizard_steps_ this-page_nameDefine the steps for the setup wizard.
includes/functions.php
convertkit_get_supported_post_typesDefines the Post Types that support ConvertKit Forms.
convertkit_shortcodesRegisters shortcodes for the ConvertKit Plugin.
convertkit_blocksRegisters blocks for the ConvertKit Plugin.
convertkit_get_block_formattersRegisters block formatters in Gutenberg for the ConvertKit Plugin.
convertkit_plugin_sidebarsRegisters plugin sidebars for the WordPress block editor.
convertkit_get_pre_publish_actionsRegisters pre-publish actions for the ConvertKit Plugin.
convertkit_get_form_importersRegisters form importers for the ConvertKit Plugin.
includes/blocks/class-convertkit-block-content.php
convertkit_block_content_renderFilters the content in the ConvertKit Custom Content block/shortcode immediately before it is output.
includes/blocks/class-convertkit-block-form-builder-field.php
convertkit_block_form_builder_field_renderFilter the block's content immediately before it is output.
includes/blocks/class-convertkit-block-product.php
convertkit_block_product_renderFilter the block's content immediately before it is output.
includes/blocks/class-convertkit-block-broadcasts.php
convertkit_block_broadcasts_renderFilter the block's content immediately before it is output.
convertkit_block_broadcasts_render_ajaxFilter the block's inner content immediately before it is output by AJAX, which occurs when pagination was clicked.
convertkit_block_broadcasts_build_html_list_itemDefines the HTML for an individual broadcast item in the Broadcasts block.
includes/blocks/class-convertkit-block-form-builder.php
convertkit_block_form_builder_renderFilter the block's content immediately before it is output.
includes/blocks/class-convertkit-block-form.php
convertkit_block_form_renderFilter the block's content immediately before it is output.
includes/blocks/class-convertkit-block-form-trigger.php
convertkit_block_form_trigger_renderFilter the block's content immediately before it is output.
includes/class-convertkit-admin-notices.php
convertkit_admin_notices_output_ noticeDefine the text to output in an admin error notice.
includes/class-convertkit-post.php
convertkit_post_settingsProgrammatically define ConvertKit settings for an individual Post, overriding those defined in the meta box.
convertkit_post_get_default_settingsThe default settings, used to populate the Post's Settings when a Post has no Settings.
includes/class-convertkit-term.php
convertkit_term_get_default_settingsThe default settings, used to populate the Term's Settings when a Term has no Settings.
includes/class-convertkit-settings-broadcasts.php
convertkit_settings_broadcasts_get_defaultsThe default settings, used when the ConvertKit Broadcasts Settings haven't been saved e.g. on a new installation.
includes/class-convertkit-settings-restrict-content.php
convertkit_settings_restrict_content_get_defaultsThe default settings, used when the ConvertKit Restrict Content Settings haven't been saved e.g. on a new installation.
includes/class-convertkit-user.php
convertkit_user_get_default_settingsThe default settings, used to populate the User's Settings when a User has no Settings.
includes/class-convertkit-gutenberg.php
convertkit_admin_gutenberg_add_block_categoriesAdds block categories to the default Gutenberg Block Categories
convertkit_gutenberg_block_api_versionDetermine the block API version to use for registering blocks.
includes/integrations/contactform7/class-convertkit-contactform7-settings.php
convertkit_contactform7_settings_get_defaultsThe default settings, used when Contact Form 7's Settings haven't been saved e.g. on a new installation or when the Contact Form 7 Plugin has just been activated for the first time.
includes/integrations/forminator/class-convertkit-forminator-settings.php
convertkit_forminator_settings_get_defaultsThe default settings, used when Forminator's Settings haven't been saved e.g. on a new installation or when the Forminator Plugin has just been activated for the first time.
includes/integrations/wishlist/class-convertkit-wishlist-settings.php
convertkit_wishlist_settings_get_defaultsThe default settings, used when WishList's Settings haven't been saved e.g. on a new installation or when the WishList Plugin has just been activated for the first time.
includes/class-convertkit-output-restrict-content.php
convertkit_output_restrict_content_get_resource_typeDefine the ConvertKit Resource Type that the visitor must be subscribed against to access this content, overriding the Post setting. Return false or an empty string to not restrict content.
convertkit_output_restrict_content_get_resource_idDefine the ConvertKit Resource ID that the visitor must be subscribed against to access this content, overriding the Post setting. Return 0 to not restrict content.
convertkit_output_restrict_content_content_previewDefine the output for the content preview when the visitor is not an authenticated subscriber.
convertkit_output_restrict_content_call_to_actionDefine the output for the call to action, displayed below the content preview, when the visitor is not an authenticated subscriber.
convertkit_output_restrict_content_container_css_classesDefine the container CSS classes to wrap the content preview and call to action within.
convertkit_output_restrict_content_is_crawler_permitted_user_agent_ip_rangesDefine the permitted user agents and their IP address ranges that can bypass Restrict Content to index content for search engines.
includes/class-convertkit-output.php
convertkit_output_page_takeover_landing_page_idDefine the ConvertKit Landing Page ID to display for the given Post ID, overriding the Post settings. Return false to not display any ConvertKit Landing Page.
convertkit_output_append_form_to_content_form_idDefine the ConvertKit Form ID to display for the given Post ID, overriding the Post, Category or Plugin settings. Return false to not display any ConvertKit Form.
convertkit_frontend_append_formFilter the Post's Content, which includes a ConvertKit Form, immediately before it is output.
convertkit_output_scripts_footerDefine an array of scripts to output in the footer of the WordPress site.
convertkit_output_script_footerFilter the form <script> key/value pairs immediately before the script is output.
includes/class-convertkit-settings.php
convertkit_settings_get_defaultsThe default settings, used when the ConvertKit Plugin Settings haven't been saved e.g. on a new installation.
includes/class-wp-convertkit.php
convertkit_is_admin_or_frontend_editorFilters whether the current request is a WordPress Administration / Frontend Editor request or not. Page Builders can set this to true to allow ConvertKit to load its administration functionality.
includes/class-convertkit-resource-forms.php
convertkit_resource_forms_output_scriptFilter the form <script> key/value pairs immediately before the script is output.
includes/class-convertkit-broadcasts-importer.php
convertkit_broadcasts_build_post_argsDefine the wp_insert_post() compatible arguments for importing a ConvertKit Broadcast to a new WordPress Post.
convertkit_broadcasts_parse_broadcast_contentParses the given Broadcast's content, removing unnecessary HTML tags and styles.
convertkit_broadcasts_parse_broadcast_content_permitted_html_tagsDefine the HTML tags to retain in the Broadcast Content.
convertkit_settings_base_register_notices
admin/section/class-convertkit-admin-section-base.php::208
Register success and error notices for settings screens.
Parameter
Type
Description
$notices
array
Regsitered success and error notices.
add_filter( 'convertkit_settings_base_register_notices', function( $notices ) {
// ... your code here
// Return value
return $notices;
}, 10, 1 );
convertkit_admin_settings_form_method
admin/class-convertkit-admin-settings.php::160
Defines the settings form's method.
Parameter
Type
Description
$form_method
string
The method of the form.
$active_section
string
The active section.
add_filter( 'convertkit_admin_settings_form_method', function( 'post', $active_section ) {
// ... your code here
// Return value
return 'post';
}, 10, 2 );
convertkit_admin_settings_form_action_url
admin/class-convertkit-admin-settings.php::170
Defines the settings form's action URL.
Parameter
Type
Description
$form_action_url
string
The URL to submit the form to.
$active_section
string
The active section.
add_filter( 'convertkit_admin_settings_form_action_url', function( admin_url( 'options.php' ) {
// ... your code here
// Return value
return admin_url( 'options.php';
}, 10, 1 );
convertkit_plugin_screen_action_links
admin/class-convertkit-admin-settings.php::240
Define links to display below the Plugin Name on the WP_List_Table at Plugins > Installed Plugins.
Parameter
Type
Description
$links
array
HTML Links.
add_filter( 'convertkit_plugin_screen_action_links', function( $links ) {
// ... your code here
// Return value
return $links;
}, 10, 1 );
convertkit_admin_settings_register_sections
admin/class-convertkit-admin-settings.php::340
Registers settings sections at Settings > Kit.
Parameter
Type
Description
$sections
array
Array of settings classes that handle individual tabs e.g. General, Tools etc.
add_filter( 'convertkit_admin_settings_register_sections', function( $sections ) {
// ... your code here
// Return value
return $sections;
}, 10, 1 );
convertkit_admin_post_register_add_new_buttons
admin/class-convertkit-admin-post.php::68
Registers 'Add New' buttons for the given Post Type's admin screen.
Parameter
Type
Description
$buttons
array
Buttons.
$post_type
string
Post Type.
add_filter( 'convertkit_admin_post_register_add_new_buttons', function( $buttons, $post_type ) {
// ... your code here
// Return value
return $buttons;
}, 10, 2 );
convertkit_admin_setup_wizard_steps_ this-page_name
admin/class-convertkit-admin-setup-wizard.php::179
Define the steps for the setup wizard.
Parameter
Type
Description
$steps
array
The steps for the setup wizard.
add_filter( 'convertkit_admin_setup_wizard_steps_ this-page_name', function( $steps ) {
// ... your code here
// Return value
return $steps;
}, 10, 1 );
convertkit_get_supported_post_types
includes/functions.php::143
Defines the Post Types that support ConvertKit Forms.
Parameter
Type
Description
$post_types
array
Post Types
add_filter( 'convertkit_get_supported_post_types', function( $post_types ) {
// ... your code here
// Return value
return $post_types;
}, 10, 1 );
convertkit_shortcodes
includes/functions.php::182
Registers shortcodes for the ConvertKit Plugin.
Parameter
Type
Description
$shortcodes
array
Shortcodes
add_filter( 'convertkit_shortcodes', function( $shortcodes ) {
// ... your code here
// Return value
return $shortcodes;
}, 10, 1 );
convertkit_blocks
includes/functions.php::206
Registers blocks for the ConvertKit Plugin.
Parameter
Type
Description
$blocks
array
Blocks
add_filter( 'convertkit_blocks', function( $blocks ) {
// ... your code here
// Return value
return $blocks;
}, 10, 1 );
convertkit_get_block_formatters
includes/functions.php::230
Registers block formatters in Gutenberg for the ConvertKit Plugin.
Parameter
Type
Description
$block_formatters
array
Block formatters.
add_filter( 'convertkit_get_block_formatters', function( $block_formatters ) {
// ... your code here
// Return value
return $block_formatters;
}, 10, 1 );
Registers plugin sidebars for the WordPress block editor.
Parameter
Type
Description
$plugin_sidebars
array
Plugin sidebars.
add_filter( 'convertkit_plugin_sidebars', function( $plugin_sidebars ) {
// ... your code here
// Return value
return $plugin_sidebars;
}, 10, 1 );
convertkit_get_pre_publish_actions
includes/functions.php::278
Registers pre-publish actions for the ConvertKit Plugin.
Parameter
Type
Description
$pre_publish_panels
array
Pre-publish actions.
add_filter( 'convertkit_get_pre_publish_actions', function( $pre_publish_actions ) {
// ... your code here
// Return value
return $pre_publish_actions;
}, 10, 1 );
convertkit_get_form_importers
includes/functions.php::303
Registers form importers for the ConvertKit Plugin.
Parameter
Type
Description
$importers
array
Importers.
add_filter( 'convertkit_get_form_importers', function( $importers ) {
// ... your code here
// Return value
return $importers;
}, 10, 1 );
convertkit_block_content_render
includes/blocks/class-convertkit-block-content.php::295
Filters the content in the ConvertKit Custom Content block/shortcode immediately before it is output.
Parameter
Type
Description
$content
string
Content
$atts
array
Block / Shortcode Attributes
$subscriber_id
int
ConvertKit Subscriber's ID
$tags
array
ConvertKit Subscriber's Tags
$tag
array
ConvertKit Subscriber's Tag that matches $atts['tag']
add_filter( 'convertkit_block_content_render', function( $content, $atts, $subscriber_id, $tags, $tag ) {
// ... your code here
// Return value
return $content;
}, 10, 5 );
convertkit_block_form_builder_field_render
includes/blocks/class-convertkit-block-form-builder-field.php::336
Filter the block's content immediately before it is output.
Parameter
Type
Description
$html
string
Field HTML.
$atts
array
Block Attributes.
add_filter( 'convertkit_block_form_builder_field_render', function( $html, $atts ) {
// ... your code here
// Return value
return $html;
}, 10, 2 );
convertkit_block_product_render
includes/blocks/class-convertkit-block-product.php::437
Filter the block's content immediately before it is output.
Parameter
Type
Description
$html
string
ConvertKit Product button HTML.
$atts
array
Block Attributes.
add_filter( 'convertkit_block_product_render', function( $html, $atts ) {
// ... your code here
// Return value
return $html;
}, 10, 2 );
convertkit_block_broadcasts_render
includes/blocks/class-convertkit-block-broadcasts.php::747
Filter the block's content immediately before it is output.
Parameter
Type
Description
$html
string
ConvertKit Broadcasts HTML.
$atts
array
Block Attributes.
add_filter( 'convertkit_block_broadcasts_render', function( $html, $atts ) {
// ... your code here
// Return value
return $html;
}, 10, 2 );
convertkit_block_broadcasts_render_ajax
includes/blocks/class-convertkit-block-broadcasts.php::661
Filter the block's inner content immediately before it is output by AJAX, which occurs when pagination was clicked.
Parameter
Type
Description
$html
string
ConvertKit Broadcasts HTML.
$atts
array
Block Attributes.
add_filter( 'convertkit_block_broadcasts_render_ajax', function( $html, $atts ) {
// ... your code here
// Return value
return $html;
}, 10, 2 );
convertkit_block_broadcasts_build_html_list_item
includes/blocks/class-convertkit-block-broadcasts.php::828
Defines the HTML for an individual broadcast item in the Broadcasts block.
Parameter
Type
Description
$html
string
HTML.
$broadcast
array
Broadcast.
$atts
array
Block attributes.
add_filter( 'convertkit_block_broadcasts_build_html_list_item', function( $html, $broadcast, $atts ) {
// ... your code here
// Return value
return $html;
}, 10, 3 );
convertkit_block_form_builder_render
includes/blocks/class-convertkit-block-form-builder.php::675
Filter the block's content immediately before it is output.
Parameter
Type
Description
$html
string
ConvertKit Native Form HTML.
$atts
array
Block Attributes.
add_filter( 'convertkit_block_form_builder_render', function( $html, $atts ) {
// ... your code here
// Return value
return $html;
}, 10, 2 );
convertkit_block_form_render
includes/blocks/class-convertkit-block-form.php::457
Filter the block's content immediately before it is output.
Parameter
Type
Description
$form
string
ConvertKit Form HTML.
$atts
array
Block Attributes.
$form_id
int
Form ID.
add_filter( 'convertkit_block_form_render', function( $form, $atts, $form_id ) {
// ... your code here
// Return value
return $form;
}, 10, 3 );
convertkit_block_form_trigger_render
includes/blocks/class-convertkit-block-form-trigger.php::381
Filter the block's content immediately before it is output.
Parameter
Type
Description
$html
string
ConvertKit Button HTML.
$atts
array
Block Attributes.
add_filter( 'convertkit_block_form_trigger_render', function( $html, $atts ) {
// ... your code here
// Return value
return $html;
}, 10, 2 );
convertkit_admin_notices_output_ notice
includes/class-convertkit-admin-notices.php::87
Define the text to output in an admin error notice.
Parameter
Type
Description
$notice
string
Admin notice name.
add_filter( 'convertkit_admin_notices_output_ notice', function( $output ) {
// ... your code here
// Return value
return $output;
}, 10, 1 );
convertkit_post_settings
includes/class-convertkit-post.php::85
Programmatically define ConvertKit settings for an individual Post, overriding those defined in the meta box.
Parameter
Type
Description
$meta
array
Post Settings.
$post_id
int
Post ID.
add_filter( 'convertkit_post_settings', function( $meta, $post_id ) {
// ... your code here
// Return value
return $meta;
}, 10, 2 );
convertkit_post_get_default_settings
includes/class-convertkit-post.php::329
The default settings, used to populate the Post's Settings when a Post has no Settings.
Parameter
Type
Description
$defaults
array
Default Settings.
$post_id
int
Post ID.
add_filter( 'convertkit_post_get_default_settings', function( $defaults, $post_id ) {
// ... your code here
// Return value
return $defaults;
}, 10, 2 );
convertkit_term_get_default_settings
includes/class-convertkit-term.php::198
The default settings, used to populate the Term's Settings when a Term has no Settings.
Parameter
Type
Description
$defaults
array
Default Form
add_filter( 'convertkit_term_get_default_settings', function( $defaults ) {
// ... your code here
// Return value
return $defaults;
}, 10, 1 );
convertkit_settings_broadcasts_get_defaults
includes/class-convertkit-settings-broadcasts.php::252
The default settings, used when the ConvertKit Broadcasts Settings haven't been saved e.g. on a new installation.
Parameter
Type
Description
$defaults
array
Default settings.
add_filter( 'convertkit_settings_broadcasts_get_defaults', function( $defaults ) {
// ... your code here
// Return value
return $defaults;
}, 10, 1 );
convertkit_settings_restrict_content_get_defaults
includes/class-convertkit-settings-restrict-content.php::164
The default settings, used when the ConvertKit Restrict Content Settings haven't been saved e.g. on a new installation.
Parameter
Type
Description
$defaults
array
Default settings.
add_filter( 'convertkit_settings_restrict_content_get_defaults', function( $defaults ) {
// ... your code here
// Return value
return $defaults;
}, 10, 1 );
convertkit_user_get_default_settings
includes/class-convertkit-user.php::107
The default settings, used to populate the User's Settings when a User has no Settings.
Parameter
Type
Description
$defaults
array
Default Settings.
add_filter( 'convertkit_user_get_default_settings', function( $defaults ) {
// ... your code here
// Return value
return $defaults;
}, 10, 1 );
convertkit_admin_gutenberg_add_block_categories
includes/class-convertkit-gutenberg.php::126
Adds block categories to the default Gutenberg Block Categories
Parameter
Type
Description
$categories
array
Block Categories
$post
WP_Post
WordPress Post
add_filter( 'convertkit_admin_gutenberg_add_block_categories', function( $categories, $post ) {
// ... your code here
// Return value
return $categories;
}, 10, 2 );
convertkit_gutenberg_block_api_version
includes/class-convertkit-gutenberg.php::279
Determine the block API version to use for registering blocks.
Parameter
Type
Description
$block_api_version
int
Block API version.
add_filter( 'convertkit_gutenberg_block_api_version', function( $block_api_version ) {
// ... your code here
// Return value
return $block_api_version;
}, 10, 1 );
convertkit_contactform7_settings_get_defaults
includes/integrations/contactform7/class-convertkit-contactform7-settings.php::149
The default settings, used when Contact Form 7's Settings haven't been saved e.g. on a new installation or when the Contact Form 7 Plugin has just been activated for the first time.
Parameter
Type
Description
$defaults
array
Default Settings.
add_filter( 'convertkit_contactform7_settings_get_defaults', function( $defaults ) {
// ... your code here
// Return value
return $defaults;
}, 10, 1 );
convertkit_forminator_settings_get_defaults
includes/integrations/forminator/class-convertkit-forminator-settings.php::153
The default settings, used when Forminator's Settings haven't been saved e.g. on a new installation or when the Forminator Plugin has just been activated for the first time.
Parameter
Type
Description
$defaults
array
Default Settings.
add_filter( 'convertkit_forminator_settings_get_defaults', function( $defaults ) {
// ... your code here
// Return value
return $defaults;
}, 10, 1 );
convertkit_wishlist_settings_get_defaults
includes/integrations/wishlist/class-convertkit-wishlist-settings.php::149
The default settings, used when WishList's Settings haven't been saved e.g. on a new installation or when the WishList Plugin has just been activated for the first time.
Parameter
Type
Description
$defaults
array
Default Settings.
add_filter( 'convertkit_wishlist_settings_get_defaults', function( $defaults ) {
// ... your code here
// Return value
return $defaults;
}, 10, 1 );
convertkit_output_restrict_content_get_resource_type
includes/class-convertkit-output-restrict-content.php::966
Define the ConvertKit Resource Type that the visitor must be subscribed against to access this content, overriding the Post setting. Return false or an empty string to not restrict content.
Parameter
Type
Description
Resource
string $resource_type
Type
$post_id
int
Post ID
add_filter( 'convertkit_output_restrict_content_get_resource_type', function( $resource_type, $post_id ) {
// ... your code here
// Return value
return $resource_type;
}, 10, 2 );
convertkit_output_restrict_content_get_resource_id
includes/class-convertkit-output-restrict-content.php::1004
Define the ConvertKit Resource ID that the visitor must be subscribed against to access this content, overriding the Post setting. Return 0 to not restrict content.
Parameter
Type
Description
$resource_id
int
Resource ID
$post_id
int
Post ID
add_filter( 'convertkit_output_restrict_content_get_resource_id', function( $resource_id, $post_id ) {
// ... your code here
// Return value
return $resource_id;
}, 10, 2 );
convertkit_output_restrict_content_content_preview
includes/class-convertkit-output-restrict-content.php::1296
Define the output for the content preview when the visitor is not an authenticated subscriber.
Parameter
Type
Description
$content_preview
string
Content preview.
$post_id
int
Post ID.
add_filter( 'convertkit_output_restrict_content_content_preview', function( $content_preview, $post_id ) {
// ... your code here
// Return value
return $content_preview;
}, 10, 2 );
convertkit_output_restrict_content_call_to_action
includes/class-convertkit-output-restrict-content.php::1310
Define the output for the call to action, displayed below the content preview, when the visitor is not an authenticated subscriber.
Parameter
Type
Description
$call_to_action
string
Call to Action.
$post_id
int
Post ID.
add_filter( 'convertkit_output_restrict_content_call_to_action', function( $call_to_action, $post_id ) {
// ... your code here
// Return value
return $call_to_action;
}, 10, 2 );
convertkit_output_restrict_content_container_css_classes
includes/class-convertkit-output-restrict-content.php::1323
Define the container CSS classes to wrap the content preview and call to action within.
Parameter
Type
Description
$container_css_classes
array
Container CSS classes.
$post_id
int
Post ID.
add_filter( 'convertkit_output_restrict_content_container_css_classes', function( $container_css_classes, $post_id ) {
// ... your code here
// Return value
return $container_css_classes;
}, 10, 2 );
convertkit_output_restrict_content_is_crawler_permitted_user_agent_ip_ranges
includes/class-convertkit-output-restrict-content.php::2051
Define the permitted user agents and their IP address ranges that can bypass Restrict Content to index content for search engines.
Parameter
Type
Description
$permitted
array
Permitted user agent and IP address ranges.
add_filter( 'convertkit_output_restrict_content_is_crawler_permitted_user_agent_ip_ranges', function( $permitted_user_agent_ip_ranges ) {
// ... your code here
// Return value
return $permitted_user_agent_ip_ranges;
}, 10, 1 );
convertkit_output_page_takeover_landing_page_id
includes/class-convertkit-output.php::279
Define the ConvertKit Landing Page ID to display for the given Post ID, overriding the Post settings. Return false to not display any ConvertKit Landing Page.
Parameter
Type
Description
$landing_page_id
int
Landing Page ID
$post_id
int
Post ID
add_filter( 'convertkit_output_page_takeover_landing_page_id', function( $landing_page_id, $post_id ) {
// ... your code here
// Return value
return $landing_page_id;
}, 10, 2 );
convertkit_output_append_form_to_content_form_id
includes/class-convertkit-output.php::359
Define the ConvertKit Form ID to display for the given Post ID, overriding the Post, Category or Plugin settings. Return false to not display any ConvertKit Form.
Parameter
Type
Description
$form_id
bool|int
Form ID
$post_id
int
Post ID
add_filter( 'convertkit_output_append_form_to_content_form_id', function( $form_id, $post_id ) {
// ... your code here
// Return value
return $form_id;
}, 10, 2 );
convertkit_frontend_append_form
includes/class-convertkit-output.php::470
Filter the Post's Content, which includes a ConvertKit Form, immediately before it is output.
Parameter
Type
Description
$content
string
Post Content
$form
string
ConvertKit Form HTML
$post_id
int
Post ID
$form_id
int
ConvertKit Form ID
$form_position
string
Form Position setting for the Post's Type.
add_filter( 'convertkit_frontend_append_form', function( $content, $form, $post_id, $form_id, $form_position ) {
// ... your code here
// Return value
return $content;
}, 10, 5 );
Define an array of scripts to output in the footer of the WordPress site.
Parameter
Type
Description
$scripts
array
Scripts.
add_filter( 'convertkit_output_scripts_footer', function( $scripts ) {
// ... your code here
// Return value
return $scripts;
}, 10, 1 );
Filter the form <script> key/value pairs immediately before the script is output.
Parameter
Type
Description
$script
array
Form script key/value pairs to output as <script> tag.
add_filter( 'convertkit_output_script_footer', function( $script ) {
// ... your code here
// Return value
return $script;
}, 10, 1 );
convertkit_settings_get_defaults
includes/class-convertkit-settings.php::624
The default settings, used when the ConvertKit Plugin Settings haven't been saved e.g. on a new installation.
Parameter
Type
Description
$defaults
array
Default Settings.
add_filter( 'convertkit_settings_get_defaults', function( $defaults ) {
// ... your code here
// Return value
return $defaults;
}, 10, 1 );
convertkit_is_admin_or_frontend_editor
includes/class-wp-convertkit.php::336
Filters whether the current request is a WordPress Administration / Frontend Editor request or not. Page Builders can set this to true to allow ConvertKit to load its administration functionality.
Parameter
Type
Description
$is_admin_or_frontend_editor
bool
Is WordPress Administration / Frontend Editor request.
add_filter( 'convertkit_is_admin_or_frontend_editor', function( $is_admin_or_frontend_editor ) {
// ... your code here
// Return value
return $is_admin_or_frontend_editor;
}, 10, 1 );
convertkit_resource_forms_output_script
includes/class-convertkit-resource-forms.php::627
Filter the form <script> key/value pairs immediately before the script is output.
Parameter
Type
Description
$script
array
Form script key/value pairs to output as <script> tag.
add_filter( 'convertkit_resource_forms_output_script', function( $script ) {
// ... your code here
// Return value
return $script;
}, 10, 1 );
convertkit_broadcasts_build_post_args
includes/class-convertkit-broadcasts-importer.php::360
Define the wp_insert_post() compatible arguments for importing a ConvertKit Broadcast to a new WordPress Post.
Parameter
Type
Description
$post_args
array
Post arguments.
$broadcast
array
Broadcast.
add_filter( 'convertkit_broadcasts_build_post_args', function( $post_args, $broadcast ) {
// ... your code here
// Return value
return $post_args;
}, 10, 2 );
convertkit_broadcasts_parse_broadcast_content
includes/class-convertkit-broadcasts-importer.php::514
Parses the given Broadcast's content, removing unnecessary HTML tags and styles.
Parameter
Type
Description
Parsed
string $content
Content.
$post_id
int
WordPress Post ID.
Broadcast
string $broadcast_title
Title.
$import_images
bool
Import images to Media Library.
$disable_styles
bool
Disable CSS styles in content.
add_filter( 'convertkit_broadcasts_parse_broadcast_content', function( $content, $post_id, $broadcast_content, $broadcast_title, $import_images, $disable_styles ) {
// ... your code here
// Return value
return $content;
}, 10, 6 );
convertkit_broadcasts_parse_broadcast_content_permitted_html_tags
includes/class-convertkit-broadcasts-importer.php::614
Define the HTML tags to retain in the Broadcast Content.
Parameter
Type
Description
$permitted_html_tags
array
Permitted HTML Tags.
add_filter( 'convertkit_broadcasts_parse_broadcast_content_permitted_html_tags', function( $permitted_html_tags ) {
// ... your code here
// Return value
return $permitted_html_tags;
}, 10, 1 );
convertkit_settings_base_render_before
admin/section/class-convertkit-admin-section-form-entries.php::124
Parameter
Type
Description
do_action( 'convertkit_settings_base_render_before', function( ) {
// ... your code here
}, 10, 0 );
convertkit_settings_base_render_after
admin/section/class-convertkit-admin-section-form-entries.php::201
Parameter
Type
Description
do_action( 'convertkit_settings_base_render_after', function( ) {
// ... your code here
}, 10, 0 );
convertkit_settings_base_render_before
admin/section/class-convertkit-admin-section-tools.php::379
Parameter
Type
Description
do_action( 'convertkit_settings_base_render_before', function( ) {
// ... your code here
}, 10, 0 );
convertkit_settings_base_render_after
admin/section/class-convertkit-admin-section-tools.php::402
Parameter
Type
Description
do_action( 'convertkit_settings_base_render_after', function( ) {
// ... your code here
}, 10, 0 );
convertkit_settings_base_render_before
admin/section/class-convertkit-admin-section-oauth.php::126
Parameter
Type
Description
do_action( 'convertkit_settings_base_render_before', function( ) {
// ... your code here
}, 10, 0 );
convertkit_settings_base_render_after
admin/section/class-convertkit-admin-section-oauth.php::136
Parameter
Type
Description
do_action( 'convertkit_settings_base_render_after', function( ) {
// ... your code here
}, 10, 0 );
convertkit_settings_base_render_before
admin/section/class-convertkit-admin-section-base.php::243
Parameter
Type
Description
do_action( 'convertkit_settings_base_render_before', function( ) {
// ... your code here
}, 10, 0 );
convertkit_settings_base_render_after
admin/section/class-convertkit-admin-section-base.php::258
Parameter
Type
Description
do_action( 'convertkit_settings_base_render_after', function( ) {
// ... your code here
}, 10, 0 );
convertkit_settings_base_sanitize_settings
admin/section/class-convertkit-admin-section-base.php::930
Parameter
Type
Description
$name
Unknown
N/A
$updated_settings
Unknown
N/A
do_action( 'convertkit_settings_base_sanitize_settings', function( $name, $updated_settings ) {
// ... your code here
}, 10, 2 );
convertkit_admin_settings_enqueue_scripts
admin/class-convertkit-admin-settings.php::68
Enqueue JavaScript for the Settings Screen at Settings > Kit
Parameter
Type
Description
$section
string
Settings section / tab (general|tools|restrict-content).
do_action( 'convertkit_admin_settings_enqueue_scripts', function( $section ) {
// ... your code here
}, 10, 1 );
convertkit_admin_settings_enqueue_styles
admin/class-convertkit-admin-settings.php::99
Enqueue CSS for the Settings Screen at Settings > Kit
Parameter
Type
Description
$section
string
Settings section / tab (general|tools|restrict-content).
do_action( 'convertkit_admin_settings_enqueue_styles', function( $section ) {
// ... your code here
}, 10, 1 );
convertkit_admin_category_enqueue_scripts
admin/class-convertkit-admin-category.php::62
Parameter
Type
Description
do_action( 'convertkit_admin_category_enqueue_scripts', function( ) {
// ... your code here
}, 10, 0 );
convertkit_admin_category_enqueue_styles
admin/class-convertkit-admin-category.php::96
Parameter
Type
Description
do_action( 'convertkit_admin_category_enqueue_styles', function( ) {
// ... your code here
}, 10, 0 );
convertkit_admin_post_enqueue_scripts
admin/class-convertkit-admin-post.php::117
Parameter
Type
Description
do_action( 'convertkit_admin_post_enqueue_scripts', function( ) {
// ... your code here
}, 10, 0 );
convertkit_admin_post_enqueue_styles
admin/class-convertkit-admin-post.php::143
Parameter
Type
Description
do_action( 'convertkit_admin_post_enqueue_styles', function( ) {
// ... your code here
}, 10, 0 );
convertkit_admin_setup_wizard_process_form_ this-page_name
admin/class-convertkit-admin-setup-wizard.php::279
Process submitted form data for the given setup wizard name and current step.
Parameter
Type
Description
$step
string
Current step.
do_action( 'convertkit_admin_setup_wizard_process_form_ this-page_name', function( $step ) {
// ... your code here
}, 10, 1 );
convertkit_admin_setup_wizard_load_screen_data_ this-page_name
admin/class-convertkit-admin-setup-wizard.php::342
Load any data into class variables for the given setup wizard name and current step.
Parameter
Type
Description
$step
string
Current step.
do_action( 'convertkit_admin_setup_wizard_load_screen_data_ this-page_name', function( $step ) {
// ... your code here
}, 10, 1 );
convertkit_pre_publish_action_run_ this-get_name
includes/pre-publish-actions/class-convertkit-pre-publish-action.php::179
Run this pre-publish action, as the WordPress Post has just transitioned to publish from another state.
Parameter
Type
Description
$post
WP_Post
Post.
do_action( 'convertkit_pre_publish_action_run_ this-get_name', function( ) {
// ... your code here
}, 10, 0 );
convertkit_gutenberg_enqueue_scripts
includes/class-convertkit-gutenberg.php::345
Enqueue any additional scripts for Gutenberg blocks that have been registered.
Parameter
Type
Description
$blocks
array
ConvertKit Blocks.
$block_formatters
array
ConvertKit Block Formatters.
do_action( 'convertkit_gutenberg_enqueue_scripts', function( $blocks, $block_formatters ) {
// ... your code here
}, 10, 2 );
convertkit_gutenberg_enqueue_styles
includes/class-convertkit-gutenberg.php::369
Parameter
Type
Description
do_action( 'convertkit_gutenberg_enqueue_styles', function( ) {
// ... your code here
}, 10, 0 );
convertkit_gutenberg_enqueue_scripts_editor_and_frontend
includes/class-convertkit-gutenberg.php::393
Parameter
Type
Description
do_action( 'convertkit_gutenberg_enqueue_scripts_editor_and_frontend', function( ) {
// ... your code here
}, 10, 0 );
convertkit_gutenberg_enqueue_styles_editor_and_frontend
includes/class-convertkit-gutenberg.php::417
Parameter
Type
Description
do_action( 'convertkit_gutenberg_enqueue_styles_editor_and_frontend', function( ) {
// ... your code here
}, 10, 0 );
convertkit_restrict_content_register_content_filter
includes/class-convertkit-output-restrict-content.php::591
Parameter
Type
Description
do_action( 'convertkit_restrict_content_register_content_filter', function( ) {
// ... your code here
}, 10, 0 );
convertkit_output_output_form
includes/class-convertkit-output.php::234
Parameter
Type
Description
do_action( 'convertkit_output_output_form', function( ) {
// ... your code here
}, 10, 0 );
convertkit_output_landing_page_before
includes/class-convertkit-output.php::315
Perform any actions immediately prior to outputting the Landing Page. Caching and minification Plugins may need to hook here to prevent CSS / JS minification and lazy loading images, which can interfere with Landing Pages.
Parameter
Type
Description
$landing_page
string
ConvertKit Landing Page HTML.
$landing_page_id
int
ConvertKit Landing Page ID.
$post_id
int
WordPress Page ID.
do_action( 'convertkit_output_landing_page_before', function( $landing_page, $landing_page_id, $post_id ) {
// ... your code here
}, 10, 3 );
convertkit_initialize_admin
includes/class-wp-convertkit.php::104
Parameter
Type
Description
do_action( 'convertkit_initialize_admin', function( ) {
// ... your code here
}, 10, 0 );
convertkit_initialize_admin_or_frontend_editor
includes/class-wp-convertkit.php::125
Parameter
Type
Description
do_action( 'convertkit_initialize_admin_or_frontend_editor', function( ) {
// ... your code here
}, 10, 0 );
convertkit_initialize_cli_cron
includes/class-wp-convertkit.php::146
Parameter
Type
Description
do_action( 'convertkit_initialize_cli_cron', function( ) {
// ... your code here
}, 10, 0 );
convertkit_initialize_frontend
includes/class-wp-convertkit.php::171
Parameter
Type
Description
do_action( 'convertkit_initialize_frontend', function( ) {
// ... your code here
}, 10, 0 );
convertkit_initialize_global
includes/class-wp-convertkit.php::215
Parameter
Type
Description
do_action( 'convertkit_initialize_global', function( ) {
// ... your code here
}, 10, 0 );