Changeset 10785

Timestamp:

05/19/2016 03:46:29 AM (9 years ago)

Author:

boonebgorges

Message:

Pass parsed function parameters to a number of template filters.

The template filters in question are ones that get their main context from
a template global (say, $members_template), but get auxiliary information
about how to build markup from the function params. As such, it's useful to
have these parameters available via filter.

Props Offereins.
See #6997.

Location:

trunk/src

Files:

• bp-activity/bp-activity-template.php (modified) (1 diff)
• bp-blogs/bp-blogs-template.php (modified) (1 diff)
• bp-members/bp-members-template.php (modified) (6 diffs)
• bp-messages/bp-messages-template.php (modified) (4 diffs)
• bp-notifications/bp-notifications-template.php (modified) (2 diffs)
• bp-xprofile/bp-xprofile-template.php (modified) (3 diffs)

trunk/src/bp-activity/bp-activity-template.php

@@ -3015 +3015 @@
          *
          * @since 1.1.0
+         * @since 2.6.0 Added the `$r` parameter.
          *
          * @param string $value All of the links to be displayed to the user.
-         */
-        return apply_filters( 'bp_get_activity_filter_links', implode( "\n", $component_links ) );
+         * @param array  $r     Array of parsed arguments.
+         */
+        return apply_filters( 'bp_get_activity_filter_links', implode( "\n", $component_links ), $r );
     }
 

trunk/src/bp-blogs/bp-blogs-template.php

@@ -632 +632 @@
          *
          * @since 1.2.0
+         * @since 2.6.0 Added the `$r` parameter.
          *
          * @param string $retval HTML markup for the latest post.
-         */
-        return apply_filters( 'bp_get_blog_latest_post', $retval );
+         * @param array  $r      Array of parsed arguments.
+         */
+        return apply_filters( 'bp_get_blog_latest_post', $retval, $r );
     }
 

trunk/src/bp-members/bp-members-template.php

@@ -431 +431 @@
      *
      * @since 1.2.4
+     * @since 2.6.0 Added the `$r` parameter
      *
      * @param bool  $value            Whether or not there are members to iterate over.
      * @param array $members_template Populated $members_template global.
-     */
-    return apply_filters( 'bp_has_members', $members_template->has_members(), $members_template );
+     * @param array $r                Array of arguments passed into the BP_Core_Members_Template class.
+     */
+    return apply_filters( 'bp_has_members', $members_template->has_members(), $members_template, $r );
 }
 
@@ -773 +775 @@
      *
      * @since 1.2.0
-     *
-     * @param string $value Formatted HTML <img> element, or raw avatar URL based on $html arg.
-     */
-    echo apply_filters( 'bp_member_avatar', bp_get_member_avatar( $args ) );
+     * @since 2.6.0 Added the `$args` parameter.
+     *
+     * @param string       $value Formatted HTML <img> element, or raw avatar URL based on $html arg.
+     * @param array|string $args  See {@link bp_get_member_avatar()}.
+     */
+    echo apply_filters( 'bp_member_avatar', bp_get_member_avatar( $args ), $args );
 }
     /**
@@ -821 +825 @@
          *
          * @since 1.2.0
+         * @since 2.6.0 Added the `$r` parameter.
          *
          * @param string $value Formatted HTML <img> element, or raw avatar URL based on $html arg.
-         */
-        return apply_filters( 'bp_get_member_avatar', bp_core_fetch_avatar( array( 'item_id' => $members_template->member->id, 'type' => $type, 'alt' => $alt, 'css_id' => $id, 'class' => $class, 'width' => $width, 'height' => $height, 'email' => $members_template->member->user_email ) ) );
+         * @param array  $r     Array of parsed arguments. See {@link bp_get_member_avatar()}.
+         */
+        return apply_filters( 'bp_get_member_avatar', bp_core_fetch_avatar( array( 'item_id' => $members_template->member->id, 'type' => $type, 'alt' => $alt, 'css_id' => $id, 'class' => $class, 'width' => $width, 'height' => $height, 'email' => $members_template->member->user_email ) ), $r );
     }
 
@@ -1034 +1040 @@
          *
          * @since 1.2.5
+         * @since 2.6.0 Added the `$r` parameter.
          *
          * @param string $value Excerpt of the latest update for current member in the loop.
-         */
-        $update_content = apply_filters( 'bp_get_activity_latest_update_excerpt', trim( strip_tags( bp_create_excerpt( $update['content'], $length ) ) ) );
+         * @param array  $r     Array of parsed arguments.
+         */
+        $update_content = apply_filters( 'bp_get_activity_latest_update_excerpt', trim( strip_tags( bp_create_excerpt( $update['content'], $length ) ) ), $r );
 
         $update_content = sprintf( _x( '- &quot;%s&quot;', 'member latest update in member directory', 'buddypress' ), $update_content );
@@ -1053 +1061 @@
          *
          * @since 1.2.0
+         * @since 2.6.0 Added the `$r` parameter.
          *
          * @param string $update_content Formatted latest update for current member.
-         */
-        return apply_filters( 'bp_get_member_latest_update', $update_content );
+         * @param array  $r              Array of parsed arguments.
+         */
+        return apply_filters( 'bp_get_member_latest_update', $update_content, $r );
     }
 
@@ -1139 +1149 @@
          *
          * @since 1.2.0
+         * @since 2.6.0 Added the `$r` parameter.
          *
          * @param string|bool $data Profile data if found, otherwise false.
+         * @param array       $r    Array of parsed arguments.
          */
         return apply_filters( 'bp_get_member_profile_data', $data );

trunk/src/bp-messages/bp-messages-template.php

@@ -683 +683 @@
          *
          * @since 1.0.0
+         * @since 2.6.0 Added the `$r` parameter.
          *
          * @param string $value User avatar string.
+         * @param array  $r     Array of parsed arguments.
          */
         return apply_filters( 'bp_get_message_thread_avatar', bp_core_fetch_avatar( array(
@@ -694 +696 @@
             'width'   => $r['width'],
             'height'  => $r['height'],
-        ) ) );
+        ) ), $r );
     }
 
@@ -1809 +1811 @@
          *
          * @since 1.1.0
+         * @since 2.6.0 Added the `$r` parameter.
          *
          * @param string $value <img> tag containing the avatar value.
+         * @param array  $r     Array of parsed arguments.
          */
         return apply_filters( 'bp_get_the_thread_message_sender_avatar_thumb', bp_core_fetch_avatar( array(
@@ -1818 +1822 @@
             'height'  => $r['height'],
             'alt'     => bp_core_get_user_displayname( $thread_template->message->sender_id )
-        ) ) );
+        ) ), $r );
     }
 

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

@@ -216 +216 @@
      *
      * @since 1.9.0
+     * @since 2.6.0 Added the `$r` parameter.
      *
      * @param bool                      $value      Whether or not there are notifications to display.
      * @param BP_Notifications_Template $query_loop BP_Notifications_Template object instance.
-     */
-    return apply_filters( 'bp_has_notifications', $query_loop->has_notifications(), $query_loop );
+     * @param array                     $r          Array of arguments passed into the BP_Notifications_Template class.
+     */
+    return apply_filters( 'bp_has_notifications', $query_loop->has_notifications(), $query_loop, $r );
 }
 
@@ -827 +829 @@
          *
          * @since 1.9.0
+         * @since 2.6.0 Added the `$r` parameter.
          *
          * @param string $retval HTML links for actions to take on single notifications.
-         */
-        return apply_filters( 'bp_get_the_notification_action_links', $retval );
+         * @param array  $r      Array of parsed arguments.
+         */
+        return apply_filters( 'bp_get_the_notification_action_links', $retval, $r );
     }
 

trunk/src/bp-xprofile/bp-xprofile-template.php

@@ -74 +74 @@
      *
      * @since 1.1.0
+     * @since 2.6.0 Added the `$r` parameter.
      *
      * @param bool   $has_groups       Whether or not there are group profiles to display.
      * @param string $profile_template Current profile template being used.
-     */
-    return apply_filters( 'bp_has_profile', $profile_template->has_groups(), $profile_template );
+     * @param array  $r                Array of arguments passed into the BP_XProfile_Data_Template class.
+     */
+    return apply_filters( 'bp_has_profile', $profile_template->has_groups(), $profile_template, $r );
 }
 
@@ -883 +885 @@
          *
          * @since 1.6.0
+         * @since 2.6.0 Added the `$level` parameter.
          *
          * @param string $retval Field visibility level label.
-         */
-        return apply_filters( 'bp_get_the_profile_field_visibility_level_label', $fields[ $level ]['label'] );
+         * @param string $level  Field visibility level.
+         */
+        return apply_filters( 'bp_get_the_profile_field_visibility_level_label', $fields[ $level ]['label'], $level );
     }
 
@@ -942 +946 @@
          *
          * @since 1.2.0
+         * @since 2.6.0 Added the `$r` parameter.
          *
          * @param mixed $value Profile data for a specific field for the user.
-         */
-        return apply_filters( 'bp_get_profile_field_data', xprofile_get_field_data( $r['field'], $r['user_id'] ) );
+         * @param array $r     Array of parsed arguments.
+         */
+        return apply_filters( 'bp_get_profile_field_data', xprofile_get_field_data( $r['field'], $r['user_id'] ), $r );
     }