Filter Reference - xwp/stream GitHub Wiki
wp_stream_account_page_title
Customize the title of the Stream Account screen.
Return
$title
(string)
Params
$title
(string) The title of the Stream Account admin screen.
Changelog
Since: 2.0.0
Source file: classes/class-wp-stream-admin.php
apply_filters( 'wp_stream_account_page_title', $title );
wp_stream_action_link_url
Customize the URL of action links in Stream Settings.
Return
$url
(string)
Params
$url
(string) The URL of the action link.
$record
(object) The record object.
Changelog
Since: 1.3.0
Source file: connectors/class-wp-stream-connector-settings.php
apply_filters( 'wp_stream_action_link_url', $url, $record );
wp_stream_agent_label
Customize the label used for author agents.
Return
$label
(string)
Params
$label
(string) The author agent label.
$agent
(string) The author agent slug, such as wp_cli
or wp_cron
.
Changelog
Since: 1.4.4
Source file: classes/class-wp-stream-author.php
apply_filters( 'wp_stream_agent_label', $label, $agent );
wp_stream_check_connector_is_excluded
Allows excluded connectors to be overridden and registered.
Return
$is_excluded
(bool)
Params
$is_excluded
(bool) True if excluded, otherwise false.
$connector
(string) The current connector's slug.
$excluded_connectors
(array) An array of all excluded connector slugs.
Changelog
Since: 1.3.0
Source file: classes/class-wp-stream-connectors.php
apply_filters( 'wp_stream_check_connector_is_excluded', $is_excluded, $connector, $excluded_connectors );
wp_stream_connectors
Allows for adding additional connectors via classes that extend WP_Stream_Connector
.
Return
$classes
(array)
Params
$classes
(array) An array of connector class names.
Changelog
Since: 0.2.0
Source file: classes/class-wp-stream-connectors.php
apply_filters( 'wp_stream_connectors', $classes );
wp_stream_disable_admin_access
Manually disable Stream from the WP Admin for certain cases, such as, blocking specific users.
Return
(bool)
Params
(bool) True if disabled, otherwise false.
Changelog
Since: 1.4.0
Source file: classes/class-wp-stream-admin.php
apply_filters( 'wp_stream_disable_admin_access', false );
wp_stream_frontend_indicator
Displays an HTML comment in the front-end head to indicate that Stream is activated, and which version is currently in use.
<!-- Stream WordPress user activity plugin v2.0.0 -->
Return
$comment
(string|bool)
Params
$comment
(string|bool) String to use as the HTML comment text. Use an empty string or FALSE
to disable.
Changelog
Since: 1.4.5
Source file: stream.php
add_filter( 'wp_stream_frontend_indicator', $comment );
wp_stream_record_array
Allows modification of record information just before logging occurs.
Return
$records
(array)
Params
$records
(array) An array of record data.
Changelog
Since: 0.2.0
Source file: classes/class-wp-stream-db.php
apply_filters( 'wp_stream_record_array', $records );