story|ftw 0.1.4 has 34 actions and 38 filters, read directly from its source code on Nov 19, 2026. The list updates automatically when a new version is released.
How to use these hooks
Actions let you run your own code at a specific moment. Filters let you change a value before the plugin uses it. Put your code in a child theme's functions.php or a code-snippets plugin, never in the plugin's own files, because updates overwrite them.
// Run your own code when story|ftw fires an action
add_action( 'cmb2_after_form', function( $cmb_id, $object_id, $object_type, $object ) {
// Your code runs here.
}, 10, 4 );
// Change a value story|ftw is about to use
add_filter( 'cmb2_meta_box_url', function( $url_scheme, $arg2 ) {
// Change $url_scheme here.
return $url_scheme;
}, 10, 2 );Parts of a name in {braces} are filled in at runtime (for example a post type or field ID). Choose Example on any hook for a ready-to-edit snippet.
All hooks
-
/** * Hook after form form has been rendered */ do_action( "cmb2_after_{$object_type}_form_{$this->cmb_id}", $object_id, $this ); -
/** * Hook after form form has been rendered */ do_action( 'cmb2_after_form', $this->cmb_id, $object_id, $object_type, $this ); -
/** * Hook before form table begins */ do_action( "cmb2_before_{$object_type}_form_{$this->cmb_id}", $object_id, $this, $object_type ); -
/** * Hook before form table begins */ do_action( 'cmb2_before_form', $this->cmb_id, $object_id, $object_type, $this ); -
/** * Filter the CMB location url */ apply_filters( 'cmb2_meta_box_url', set_url_scheme( $cmb2_url ), CMB2_VERSION ); -
/** * Filter whether to override removing of meta value. */ apply_filters( "cmb2_override_{$a['field_id']}_meta_remove", $override, $a, $this->args(), $this ); -
/** * Filter whether to override saving of meta value. */ apply_filters( "cmb2_override_{$a['field_id']}_meta_save", $override, $a, $this->args(), $this ); -
/** * Filter whether to override getting of meta value. */ apply_filters( "cmb2_override_{$this->id(true)}_meta_value", $this->value, $this->object_id, $this->args(), $this->object_type, $this ); -
/** * Filter whether to override removing of meta value. Returning a non-null * value will effectively short-circuit the function. */ apply_filters( 'cmb2_override_meta_remove', null, $a, $this->args(), $this ); -
/** * Filter whether to override saving of meta value. Returning a non-null value * will effectively short-circuit the function. */ apply_filters( 'cmb2_override_meta_save', null, $a, $this->args(), $this ); -
/** * Filter whether to override getting of meta value. Returning a non * 'cmb2_field_no_override_val' value will effectively short-circuit the value * retrieval. */ apply_filters( 'cmb2_override_meta_value', 'cmb2_field_no_override_val', $this->object_id, $this->args(), $this->object_type, $this ); -
/** * Pass non-existent field types through an action */ do_action( "cmb2_render_{$name}", $this->field, $this->field->escaped_value(), $this->field->object_id, $this->field->object_type, $this ); -
/** * Filter the value before it is saved. */ apply_filters( "cmb2_sanitize_{$this->field->type()}", null, $value, $this->field->object_id, $this->field->args(), $this ); -
/** * Fires after all fields have been saved. */ do_action( "cmb2_save_{$object_type}_fields", $object_id, $this->cmb_id, $this->updated, $this ); -
/** * DEPRECATED. See documentation above. */ apply_filters( "cmb2_validate_{$this->field->type()}", $override_value, $value, $this->field->object_id, $this->field->args(), $this ); -
apply_filters( 'plugin_locale', get_locale(), 'cmb2' ); -
apply_filters( "{$this->button_slug}_shortcode_fields", $fields, $this, empty( $unmodified_fields ) ? $fields : $unmodified_fields ); -
apply_filters( "cmb2_{$element}_attributes", $this->field->maybe_set_attributes( $args ), $defaults, $this->field, $this ); -
apply_filters( 'cmb2_all_or_nothing_types', array( 'taxonomy_select', 'taxonomy_radio', 'taxonomy_radio_inline' ), $this ); -
apply_filters( 'cmb2_default_filter', $args['default'], $this ); -
apply_filters( 'cmb2_get_metabox_form', $form, $object_id, $cmb ); -
apply_filters( 'cmb2_get_metabox_form_format', $args['form_format'], $object_id, $cmb ); -
apply_filters( 'cmb2_localized_data', array( 'ajax_nonce' => wp_create_nonce( 'ajax_nonce' ), 'ajaxurl' => admin_url( '/admin-ajax.php' ), 'script_debug' => defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG, 'up_arrow_class' => 'dashicons dashicons-arrow-up-alt2', 'down_arrow_class' => 'dashicons dashicons-arrow-down-alt2', 'defaults' => array( 'color_picker' => false, 'date_picker' => array( 'changeMonth' => true, 'changeYear' => true, 'd... ); -
apply_filters( 'cmb2_meta_boxes', array() ); -
apply_filters( "cmb2_override_option_get_{$this->key}", 'cmb2_no_override_option_get', $default, $this ); -
apply_filters( "cmb2_override_option_save_{$this->key}", 'cmb2_no_override_option_save', $this->options, $this ); -
apply_filters( 'cmb2_repeat_table_row_types', array( 'text_url', 'text' ) ); -
apply_filters( 'cmb2_row_classes', $classes, $this ); -
do_action( 'cmb2_save_options-page_fields', $object_id, $cmb->cmb_id, $cmb->updated, $cmb ); -
apply_filters( 'cmb2_show_on', true, $this->cmb->meta_box, $this->cmb ); -
apply_filters( "cmb2_taxonomy_radio_{$this->_id()}_default_value", apply_filters( 'cmb2_taxonomy_radio_default_value', '' ) ); -
apply_filters( 'cmb2_taxonomy_radio_default_value', '' ); -
apply_filters( "cmb2_taxonomy_select_{$this->_id()}_default_value", $option_none_value ); -
apply_filters( 'cmb2_taxonomy_select_default_value', '' ); -
apply_filters( "cmb2_types_esc_{$this->type()}", null, $meta_value, $this->args(), $this ); -
apply_filters( 'cmb2_valid_img_types', array( 'jpg', 'jpeg', 'png', 'gif', 'ico', 'icon' ) ); -
apply_filters( 'excerpt_length', 55 ); -
apply_filters( 'excerpt_more', ' ' . '…' ); -
apply_filters( 'shortcode_button_js_url', set_url_scheme( str_ireplace( ABSPATH, site_url( '/' ), trailingslashit( dirname( __FILE__ ) ) . 'js' ) ) ); -
apply_filters( 'storftw_whitelist_css', $this->whitelist_css ); -
apply_filters( 'storftw_whitelist_scripts', $this->whitelist_js ); -
apply_filters( 'story_page_permalink', $permalink, $post ); -
do_action( 'storyftw_after_content', $page_number, $story_view ); -
do_action( 'storyftw_after_loop', $story_view ); -
do_action( 'storyftw_after_story_page', $page_number, $story_view ); -
do_action( 'storyftw_after_toc', $story_view ); -
do_action( 'storyftw_after_wrap', $page_number, $story_view ); -
do_action( 'storyftw_before_content', $page_number, $story_view ); -
do_action( 'storyftw_before_loop', $story_view ); -
do_action( 'storyftw_before_story_page', $page_number, $story_view ); -
do_action( 'storyftw_before_toc', $story_view ); -
do_action( 'storyftw_before_wrap', $page_number, $story_view ); -
do_action( 'storyftw_bg_video', $page_number, $story_view ); -
apply_filters( 'storyftw_editor_styles', $css_params, $this ); -
do_action( 'storyftw_head' ); -
do_action( 'storyftw_inside_wrap', $page_number, $story_view ); -
do_action( 'storyftw_inside_wrap_after', $page_number, $story_view ); -
apply_filters( 'storyftw_story_select_post_types', array( 'page' ) ); -
do_action( 'storyftw_toc', $story_view ); -
do_action( 'storyftw_toc_end' ); -
do_action( 'storyftw_toc_item', $post ); -
do_action( 'storyftw_toc_start' ); -
do_action( 'storyftw_top', $story_view ); -
apply_filters( 'the_content', $text );
Generated from story|ftw's GPL-licensed source code. Hooks inside bundled third-party libraries are not listed.
Done for you
Rather have it built for you?
Tell us what should change and we’ll write and test the code using these hooks.
Custom hook snippet
from $49
A small, update-safe change built on the plugin’s own hooks.
- Code written against the plugin’s actions and filters
- Tested on a staging copy of your site
- Install instructions included
Typical turnaround: 2–3 business days
Choose thisPlugin customisation
from $149
New features or changed behaviour, without editing the plugin’s files.
- Built as a companion plugin, so updates never wipe it
- Exact quote before we start
- Tested on staging, then deployed
Typical turnaround: 3–7 business days
Choose thisNot sure which fits? Describe what you need and we’ll suggest the simplest option.
Can't find the right hook?
We can build the customisation for you. Describe what you need: