Changeset 11306 for trunk/src/bp-messages/classes/class-bp-messages-message.php

Timestamp:

12/19/2016 10:24:19 PM (8 years ago)

Author:

slaffik

Message:

Messages: new filter for get_recipients_ids()

Give ability to filter the array of recipients IDs. For BC we can't explicitly make it always return array, so if no usernames provided, false will be returned.

See #5193.

File:

• trunk/src/bp-messages/classes/class-bp-messages-message.php (modified) (2 diffs)

trunk/src/bp-messages/classes/class-bp-messages-message.php

@@ -193 +193 @@
      *
      * @param array $recipient_usernames Usernames of recipients.
-     * @return array $recipient_ids Array of Recepient IDs.
+     *
+     * @return bool|array $recipient_ids Array of Recepient IDs.
      */
     public static function get_recipient_ids( $recipient_usernames ) {
-        if ( !$recipient_usernames )
-            return false;
+        $recipient_ids = false;
+
+        if ( ! $recipient_usernames ) {
+            return $recipient_ids;
+        }
 
         if ( is_array( $recipient_usernames ) ) {
-            for ( $i = 0, $count = count( $recipient_usernames ); $i < $count; ++$i ) {
-                if ( $rid = bp_core_get_userid( trim($recipient_usernames[$i]) ) ) {
+            $rec_un_count = count( $recipient_usernames );
+
+            for ( $i = 0, $count = $rec_un_count; $i < $count; ++ $i ) {
+                if ( $rid = bp_core_get_userid( trim( $recipient_usernames[ $i ] ) ) ) {
                     $recipient_ids[] = $rid;
                 }
@@ -207 +213 @@
         }
 
-        return $recipient_ids;
+        /**
+         * Filters the array of recipients IDs.
+         *
+         * @since 2.8.0
+         *
+         * @param array $recipient_ids Array of recipients IDs that were retrieved based on submitted usernames.
+         * @param array $recipient_usernames Array of recipients usernames that were submitted by a user.
+         */
+        return apply_filters( 'messages_message_get_recipient_ids', $recipient_ids, $recipient_usernames );
     }