Stream icon
Admin & Maintenance

Stream hooks reference

  • By XWP
  • v4.5.1 New
  • Updated

Stream 4.5.1 has 16 actions and 81 filters, read directly from its source code on Nov 17, 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.

functions.phpyour child theme
// Run your own code when Stream fires an action
add_action( 'wp_stream_auto_purge', function() {
	// Your code runs here.
}, 10, 1 );

// Change a value Stream is about to use
add_filter( 'wp_stream_alerts_save_meta', function( $alert_meta, $alert_type ) {
	// Change $alert_meta here.
	return $alert_meta;
}, 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

  • connectors/class-connector-jetpack.php line 163 · used in 2 places
    /**
     * This filter is documented in Jetpack.
     */
    apply_filters( "jetpack_module_configurable_{$slug}", false );
  • classes/class-alerts-admin-ui.php line 565 · used in 2 places
    /**
     * Filter alert trigger meta before it is saved.
     */
    apply_filters( 'wp_stream_alerts_save_meta', $alert_meta, $alert_type );
  • classes/class-admin-purge.php line 559 · used in 2 places
    /**
     * Fires once per auto-purge cycle, after all bail-out checks pass and
     * immediately before deletion work is enqueued.
     */
    do_action( 'wp_stream_auto_purge' );
  • classes/class-admin-purge.php line 326 · used in 2 places
    /**
     * Filters the number of records in the {$wpdb->stream} table to do at a time.
     */
    apply_filters( 'wp_stream_batch_size', 250000 );
  • classes/class-plugin.php line 193 · used in 2 places
    /**
     * Filter the database driver class name used by Stream.
     */
    apply_filters( 'wp_stream_db_driver', '\WP_Stream\DB_Driver_WPDB' );
  • classes/class-admin-purge.php line 385 · used in 2 places
    /**
     * Filter whether Stream schedules its TTL record auto-purge at all.
     */
    apply_filters( 'wp_stream_enable_auto_purge', true );
  • atom_head

    action
    includes/feeds/atom.php line 29
    /**
     * Action fires during RSS head
     */
    do_action( 'atom_head' );
  • atom_item

    action
    includes/feeds/atom.php line 59
    /**
     * Action fires during Atom item
     */
    do_action( 'atom_item' );
  • atom_ns

    action
    includes/feeds/atom.php line 16
    /**
     * This action is documented in WordPress core (`atom_ns`).
     */
    do_action( 'atom_ns' );
  • connectors/class-connector-edd.php line 197
    /**
     * This filter is documented in Easy Digital Downloads.
     */
    apply_filters( 'edd_api_log_requests', true );
  • rss2_head

    action
    includes/feeds/rss-2.0.php line 43
    /**
     * Action fires during RSS head
     */
    do_action( 'rss2_head' );
  • rss2_item

    action
    includes/feeds/rss-2.0.php line 70
    /**
     * Action fires during RSS item
     */
    do_action( 'rss2_item' );
  • rss2_ns

    action
    includes/feeds/rss-2.0.php line 27
    /**
     * Action fires during RSS xmls printing
     */
    do_action( 'rss2_ns' );
  • connectors/class-connector-widgets.php line 847
    /**
     * Filter allows for insertion of sidebar widgets
     */
    apply_filters( 'sidebars_widgets', get_option( 'sidebars_widgets', array() ) );
  • docs/examples/stream-noop-connector/stream-noop-connector.php line 110
    /**
     * Fires when the sample noop demo button is clicked.
     */
    do_action( 'stream_noop_demo_clicked' );
  • classes/class-list-table-query-builder.php line 96
    /**
     * Filter records per page for the Stream list table query.
     */
    apply_filters( 'stream_records_per_page', $args['records_per_page'] );
  • abilities/class-ability-get-connectors.php line 109
    /**
     * Filter the connector list returned by the get-connectors ability.
     */
    apply_filters( 'wp_stream_abilities_connectors', $this->plugin->connectors->get_all( true ) );
  • connectors/class-connector-acf.php line 120
    /**
     * Allow devs to disable logging values of rendered forms
     */
    apply_filters( 'wp_stream_acf_enable_value_logging', true );
  • classes/class-admin-assets.php line 204
    /**
     * Filter the Stream admin body classes
     */
    apply_filters( 'wp_stream_admin_body_classes', $stream_classes );
  • classes/class-admin-menu.php line 114
    /**
     * Fires before submenu items are added to the Stream menu allowing plugins to
     * add menu items before Settings
     */
    do_action( 'wp_stream_admin_menu' );
  • classes/class-admin-menu.php line 136
    /**
     * Fires just before the Stream list table is registered.
     */
    do_action( 'wp_stream_admin_menu_screens' );
  • classes/class-admin-menu.php line 82
    /**
     * Filter the main admin menu title
     */
    apply_filters( 'wp_stream_admin_menu_title', esc_html__( 'Stream', 'stream' ) );
  • classes/class-admin-menu.php line 98
    /**
     * Filter the main admin page title
     */
    apply_filters( 'wp_stream_admin_page_title', esc_html__( 'Stream Records', 'stream' ) );
  • classes/class-connectors.php line 240
    /**
     * Fires after all connectors have been registered.
     */
    do_action( 'wp_stream_after_connectors_registration', $labels, $this );
  • classes/class-list-table.php line 945
    /**
     * Fires after the list table is displayed.
     */
    do_action( 'wp_stream_after_list_table' );
  • classes/class-author.php line 307
    /**
     * Filter agent labels
     */
    apply_filters( 'wp_stream_agent_label', $label, $agent );
  • connectors/class-connector-ai-client.php line 252
    /**
     * Filters the AI prompt text before Stream stores it.
     */
    apply_filters( 'wp_stream_ai_client_log_prompt', $prompt_text, $event );
  • connectors/class-connector-ai-client.php line 317
    /**
     * Filters the AI response text before Stream stores it.
     */
    apply_filters( 'wp_stream_ai_client_log_response', $response_text, $event );
  • alerts/class-alert-type-ifttt.php line 250
    /**
     * Filter the date format string
     */
    apply_filters( 'wp_stream_alert_ifttt_date_format', 'Y-m-d H:i:s', $alert, $recordarr );
  • alerts/class-alert-type-ifttt.php line 236
    /**
     * Filter User data field.
     */
    apply_filters( 'wp_stream_alert_ifttt_user_data_value', 'user_login', $alert, $recordarr );
  • alerts/class-alert-type-ifttt.php line 283
    /**
     * Filter the first IFTTT alert value
     */
    apply_filters( 'wp_stream_alert_ifttt_value_one', $record_data['summary'], $alert, $recordarr );
  • alerts/class-alert-type-ifttt.php line 302
    /**
     * Filter the third IFTTT alert value
     */
    apply_filters( 'wp_stream_alert_ifttt_value_three', $date, $alert, $recordarr );
  • alerts/class-alert-type-ifttt.php line 293
    /**
     * Filter the second IFTTT alert value
     */
    apply_filters( 'wp_stream_alert_ifttt_value_two', $user_value, $user_id, $alert, $recordarr );
  • classes/class-alert.php line 262
    /**
     * Filter whether an alert trigger matches a record.
     */
    apply_filters( 'wp_stream_alert_trigger_check', true, $record_id, $recordarr, $this );
  • classes/class-alerts-admin-ui.php line 319
    /**
     * Fires when displaying the alert trigger form.
     */
    do_action( 'wp_stream_alert_trigger_form_display', $form, $alert );
  • classes/class-alerts.php line 186
    /**
     * Allows for adding additional alert_triggers via classes that extend
     * Notifier.
     */
    apply_filters( 'wp_stream_alert_triggers', $classes );
  • classes/class-alerts.php line 142
    /**
     * Allows for adding additional alert_types via classes that extend Notifier.
     */
    apply_filters( 'wp_stream_alert_types', $classes );
  • classes/class-log.php line 133
    /**
     * Filter the blog ID stored on a Stream record.
     */
    apply_filters( 'wp_stream_blog_id_logged', get_current_blog_id() );
  • classes/class-admin-assets.php line 137
    /**
     * The maximum number of items that can be updated in bulk without receiving a
     * warning.
     */
    apply_filters( 'wp_stream_bulk_actions_threshold', 100 );
  • classes/class-connectors.php line 193
    /**
     * Allows excluded connectors to be overridden and registered.
     */
    apply_filters( 'wp_stream_check_connector_is_excluded', in_array( $connector->name, $excluded_connectors, true ), $connector->name, $excluded_connectors );
  • classes/class-plugin.php line 473
    /**
     * Filter the client IP address stored on Stream records.
     */
    apply_filters( 'wp_stream_client_ip_address', $this->client_ip_address );
  • connectors/class-connector-comments.php line 97
    /**
     * Filter comment type labels for the Comments connector.
     */
    apply_filters( 'wp_stream_comments_comment_type_labels', array( 'comment' => esc_html__( 'Comment', 'stream' ), 'trackback' => esc_html__( 'Trackback', 'stream' ), 'pingback' => esc_html__( 'Pingback', 'stream' ), ) );
  • connectors/class-connector-comments.php line 669
    /**
     * Filter excluded comment types for the Comments connector.
     */
    apply_filters( 'wp_stream_comments_exclude_comment_types', array() );
  • classes/class-connectors.php line 267
    /**
     * Allows for adding additional connectors via classes that extend Connector.
     */
    apply_filters( 'wp_stream_connectors', $instances );
  • classes/class-author.php line 281
    /**
     * Filter the current agent string
     */
    apply_filters( 'wp_stream_current_agent', $agent );
  • classes/class-query.php line 112
    /**
     * Filter allows the result count query to be modified before execution.
     */
    apply_filters( 'wp_stream_db_count_query', $count_query, $args );
  • classes/class-query.php line 98
    /**
     * Filter allows the final query to be modified before execution
     */
    apply_filters( 'wp_stream_db_query', $query, $args );
  • classes/class-query.php line 79
    /**
     * Filters query WHERE statement as an alternative to filtering the $query
     * using the hook below.
     */
    apply_filters( 'wp_stream_db_query_where', $where );
  • classes/class-db-driver-wpdb.php line 41
    /**
     * Filter the database table prefix used for Stream tables.
     */
    apply_filters( 'wp_stream_db_tables_prefix', $wpdb->base_prefix );
  • classes/class-install.php line 318
    /**
     * Filter to alter the DB update versions array
     */
    apply_filters( 'wp_stream_db_update_versions', $db_update_versions );
  • connectors/class-connector-editor.php line 111
    /**
     * Filter available contexts for the Editor connector
     */
    apply_filters( 'wp_stream_editor_context', $context, $location );
  • connectors/class-connector-editor.php line 78
    /**
     * Filter available context labels for the Editor connector
     */
    apply_filters( 'wp_stream_editor_context_labels', array( 'themes' => esc_html__( 'Themes', 'stream' ), 'plugins' => esc_html__( 'Plugins', 'stream' ), ) );
  • classes/class-export.php line 178
    /**
     * Filter to change how many records are exported. Increasing this too much
     * could cause your export to time out.
     */
    apply_filters( 'wp_stream_export_limit', 10000 );
  • classes/class-export.php line 237
    /**
     * Allows for adding additional exporters via classes that extend Exporter.
     */
    apply_filters( 'wp_stream_exporters', $classes );
  • classes/class-form-generator.php line 219
    /**
     * Filter HTML for an unrecognized form field type.
     */
    apply_filters( 'wp_stream_form_render_field', $output, $field_type, $args );
  • classes/class-plugin.php line 375
    /**
     * Filter allows the HTML output of the frontend indicator comment to be
     * altered or removed, if desired.
     */
    apply_filters( 'wp_stream_frontend_indicator', $comment );
  • classes/class-author.php line 220
    /**
     * Filter the separator between role names in the author display.
     */
    apply_filters( 'wp_stream_get_role_list_separator', ' - ' );
  • classes/class-network.php line 283
    /**
     * Filter hidden option fields on per-site settings when network activated.
     */
    apply_filters( 'wp_stream_hidden_option_fields', array( 'general' => array( 'records_ttl', ), 'advanced' => array( 'delete_all_records', ), ) );
  • classes/class-list-table-column-renderer.php line 153
    /**
     * Allows for the addition of content under a specified column.
     */
    apply_filters( "wp_stream_insert_column_default_{$column_name}", $out, $record, $column_name );
  • classes/class-plugin.php line 509
    /**
     * Filters whether or not the number of records should be considered a large
     * table.
     */
    apply_filters( 'wp_stream_is_large_records_table', $record_number > 1000000, $record_number );
  • classes/class-plugin.php line 444
    /**
     * Filter allows the network activated detection to be overridden.
     */
    apply_filters( 'wp_stream_is_network_activated', $is_network_activated, $this );
  • connectors/class-connector-settings.php line 359
    /**
     * Filters the boolean output for is_option_ignored().
     */
    apply_filters( 'wp_stream_is_option_ignored', in_array( $option_name, $default_ignored, true ), $option_name, $default_ignored );
  • classes/class-log.php line 228
    /**
     * Filters whether or not a record should be excluded from the log.
     */
    apply_filters( 'wp_stream_is_record_excluded', $exclude_record, $record );
  • classes/class-list-table.php line 144
    /**
     * Allows devs to add new columns to table
     */
    apply_filters( 'wp_stream_list_table_columns', array( 'date' => __( 'Date', 'stream' ), 'summary' => __( 'Summary', 'stream' ), 'user_id' => __( 'User', 'stream' ), 'context' => __( 'Context', 'stream' ), 'action' => __( 'Action', 'stream' ), 'ip' => __( 'IP Address', 'stream' ), ) );
  • classes/class-list-table.php line 528
    /**
     * Filter allows additional filters in the list table dropdowns Note the format
     * of the filters above, with they key and array containing a title and array
     * of items.
     */
    apply_filters( 'wp_stream_list_table_filters', $filters );
  • classes/class-list-table.php line 59
    /**
     * Filter the list table screen ID
     */
    apply_filters( 'wp_stream_list_table_screen_id', $screen_id );
  • classes/class-connector.php line 181
    /**
     * Override the data logged. Returning false to this filter will stop the data
     * from being logged. Examples of this filter in use can be found in some of
     * the custom connectors.
     */
    apply_filters( 'wp_stream_log_data', compact( 'connector', 'message', 'args', 'object_id', 'context', 'action', 'user_id' ) );
  • classes/class-plugin.php line 221
    /**
     * Filter the log handler instance used to persist Stream records.
     */
    apply_filters( 'wp_stream_log_handler', new Log( $this ) );
  • classes/class-admin-menu.php line 91
    /**
     * Filter the main admin menu position
     */
    apply_filters( 'wp_stream_menu_position', '2.999999' );
  • classes/class-network.php line 300
    /**
     * Filter hidden option fields on network settings when network activated.
     */
    apply_filters( 'wp_stream_network_option_fields', array( 'general' => array( 'role_access', ), 'exclude' => array( 'authors', 'roles', 'connectors', 'contexts', 'actions', 'ip_addresses', 'hide_previous_records', ), ) );
  • connectors/class-connector-posts.php line 351
    /**
     * Filter excluded post types for the Posts connector.
     */
    apply_filters( 'wp_stream_posts_exclude_post_types', array( 'nav_menu_item', 'attachment', 'revision', ) );
  • classes/class-date-interval.php line 65
    /**
     * Allow other plugins to filter the predefined date intervals.
     */
    apply_filters( 'wp_stream_predefined_date_intervals', $date_intervals, $timezone );
  • classes/class-admin.php line 153
    /**
     * Filters the maximum number of users preloaded into a picker.
     */
    apply_filters( 'wp_stream_preload_users_max', $this->preload_users_max );
  • classes/class-db.php line 240
    /**
     * Filter allows additional arguments to query $args
     */
    apply_filters( 'wp_stream_query_args', $args );
  • classes/class-db.php line 221
    /**
     * Filter allows additional query properties to be added
     */
    apply_filters( 'wp_stream_query_properties', $properties );
  • classes/class-list-table.php line 852
    /**
     * Filter the records screen actions dropdown menu
     */
    apply_filters( 'wp_stream_record_actions_menu', array() );
  • classes/class-db.php line 54
    /**
     * Filter allows modification of record information
     */
    apply_filters( 'wp_stream_record_array', $record );
  • classes/class-list-table.php line 911
    /**
     * Filter CSS classes on a Stream list table row.
     */
    apply_filters( 'wp_stream_record_classes', array(), $item );
  • classes/class-db.php line 70
    /**
     * Fires on a record insertion error
     */
    do_action( 'wp_stream_record_insert_error', $record, false );
  • classes/class-db.php line 81
    /**
     * Fires after a record has been inserted
     */
    do_action( 'wp_stream_record_inserted', $record_id, $record );
  • classes/class-list-table-column-renderer.php line 137
    /**
     * Registers new Columns to be inserted into the table. The cell contents of
     * this column is set below with 'wp_stream_insert_column_default_'
     */
    apply_filters_deprecated( 'wp_stream_register_column_defaults', array( array() ), sprintf( __( '%s of Stream', 'stream' ), '4.0.1' ), 'wp_stream_list_table_columns', __( 'This filter is being deprecated as it is redundant. You can define custom column names and titles using the `wp_stream_list_table_columns` filter then provide the value for the custom columns using the `wp_stream_insert_column_default_{$column_name}` filter.', 'stream' ) );
  • classes/class-ability.php line 180
    /**
     * Filters the alert_meta keys treated as credentials and withheld from ability
     * output.
     */
    apply_filters( 'wp_stream_secret_alert_meta_keys', self::SECRET_ALERT_META_KEYS, $alert_meta );
  • connectors/class-connector-settings.php line 450
    /**
     * Filter allows for insertion of serialized labels
     */
    apply_filters( 'wp_stream_serialized_labels', $labels );
  • classes/class-admin-screen-settings.php line 71
    /**
     * Filter the settings form action URL.
     */
    apply_filters( 'wp_stream_settings_form_action', admin_url( 'options.php' ) );
  • classes/class-admin-screen-settings.php line 78
    /**
     * Filter the settings page description.
     */
    apply_filters( 'wp_stream_settings_form_description', '' );
  • classes/class-admin-menu.php line 121
    /**
     * Filter the Settings admin page title
     */
    apply_filters( 'wp_stream_settings_form_title', esc_html__( 'Stream Settings', 'stream' ) );
  • classes/class-settings-registry.php line 160
    /**
     * Filter allows for modification of options fields
     */
    apply_filters( 'wp_stream_settings_option_fields', $fields );
  • classes/class-settings.php line 131
    /**
     * Filter the settings option key.
     */
    apply_filters( 'wp_stream_settings_option_key', $option_key );
  • classes/class-settings.php line 253
    /**
     * Filter allows for modification of options
     */
    apply_filters( 'wp_stream_settings_options', $options, $option_key );
  • connectors/class-connector-taxonomies.php line 269
    /**
     * Filter excluded taxonomies for the Taxonomies connector.
     */
    apply_filters( 'wp_stream_taxonomies_exclude_taxonomies', array( 'nav_menu', ) );
  • classes/class-connector.php line 134
    /**
     * Action fires during testing to test the current callback
     */
    do_action( "wp_stream_test_{$callback[1]}" );
  • classes/class-plugin.php line 288
    /**
     * Filter whether Stream uses Action Scheduler for its deferred work.
     */
    apply_filters( 'wp_stream_use_action_scheduler', $this->action_scheduler_available );
  • connectors/class-connector-woocommerce.php line 172
    /**
     * Filter WooCommerce connector context labels.
     */
    apply_filters( 'wp_stream_woocommerce_contexts', $context_labels );
  • connectors/class-connector-woocommerce.php line 245
    /**
     * Filter WooCommerce custom settings tracked by the connector.
     */
    apply_filters( 'wp_stream_woocommerce_custom_settings', $custom_settings );

Generated from Stream's GPL-licensed source code. Hooks inside bundled third-party libraries are not listed.

Can't find the right hook?

We can build the customisation for you. Describe what you need: