xprofile_format_notifications( string $action, int $item_id, int $secondary_item_id, int $total_items, string $format = 'string' )
Format notifications for the extended profile (Xprofile) component.
Description
Parameters
- $action
-
(Required) The kind of notification being rendered.
- $item_id
-
(Required) The primary item ID.
- $secondary_item_id
-
(Required) The secondary item ID.
- $total_items
-
(Required) The total number of messaging-related notifications waiting for the user.
- $format
-
(Optional) 'string' for BuddyBar-compatible notifications; 'array' for WP Toolbar. Default: 'string'.
Default value: 'string'
Return
(string)
Source
File: bp-xprofile/bp-xprofile-notifications.php
function xprofile_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) { switch ( $action ) { default: /** * Allows plugins to filter extended profile-related custom notifications. * Notifications must have a 'component_name' of 'xprofile' to be routed * to this function. * * @since BuddyPress 2.4.0 * * @param string $notification Null value. * @param int $item_id The primary item ID. * @param int $secondary_item_id The secondary item ID. * @param int $total_items The total number of messaging-related notifications * waiting for the user. * @param string $format 'string' for BuddyBar-compatible notifications; * 'array' for WP Toolbar. */ $custom_action_notification = apply_filters( 'bp_xprofile_' . $action . '_notification', null, $item_id, $secondary_item_id, $total_items, $format ); if ( ! is_null( $custom_action_notification ) ) { return $custom_action_notification; } break; } return false; }
Changelog
Version | Description |
---|---|
BuddyPress 2.4.0 | Introduced. |
Questions?
We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.