Changeset 10725 for trunk/src/bp-notifications/bp-notifications-functions.php

Timestamp:

04/27/2016 07:18:01 PM (8 years ago)

Author:

r-a-y

Message:

Notifications: Introduce two new parameters to the 'bp_notifications_get_notifications_for_user' filter.

This commit:

• Adds $component_action_name and $component_name as the 6th and 7th parameters to the filter.
• Updates the DocBlock for the filter.

In the DocBlock, we are deprecating the first parameter, which is the
component action name. It is recommended to do notification action name
checks against the 6th parameter from now on.

The reason why we are deprecating the first parameter is due to potential
plugin conflicts. If a plugin is doing a specific check on the notification
action and changes the return value for the filter, then no other plugin
can do checks for that same notification action. Also see #6669.

Fixes #7020.

File:

• trunk/src/bp-notifications/bp-notifications-functions.php (modified) (2 diffs)

trunk/src/bp-notifications/bp-notifications-functions.php

@@ -271 +271 @@
                     $component_action_items[0]->secondary_item_id,
                     $action_item_count,
-                    $format
+                    $format,
+                    $component_action_name, // Duplicated so plugins can check the canonical action name.
+                    $component_name
                 );
 
@@ -278 +280 @@
 
                     /**
-                     * Filters the notifications for a user.
+                     * Filters the notification content for notifications created by plugins.
+                     *
+                     * If your plugin extends the {@link BP_Component} class, you should use the
+                     * 'notification_callback' parameter in your extended
+                     * {@link BP_Component::setup_globals()} method instead.
                      *
                      * @since 1.9.0
+                     * @since 2.6.0 Added $component_action_name and $component_name as parameters.
                      *
-                     * @param array $ref_array Array of properties for the current notification being rendered.
+                     * @param string $content               Component action. Deprecated. Do not do checks against this! Use
+                     *                                      the 6th parameter instead - $component_action_name.
+                     * @param int    $item_id               Notification item ID.
+                     * @param int    $secondary_item_id     Notification secondary item ID.
+                     * @param int    $action_item_count     Number of notifications with the same action.
+                     * @param string $format                Format of return. Either 'string' or 'object'.
+                     * @param string $component_action_name Canonical notification action.
+                     * @param string $component_name        Notification component ID.
+                     *
+                     * @return string|array If $format is 'string', return a string of the notification content.
+                     *                      If $format is 'object', return an array formatted like:
+                     *                      array( 'text' => 'CONTENT', 'link' => 'LINK' )
                      */
                     $content = apply_filters_ref_array( 'bp_notifications_get_notifications_for_user', $ref_array );