Contents

Code Reference Functions xprofile_format_notifications()

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

25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 2.4.0 Introduced.

Uses

Uses
Uses Description
bp-xprofile/bp-xprofile-notifications.php: bp_xprofile_{$action}_notification

Allows plugins to filter extended profile-related custom notifications.

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.