Changeset 10785 for trunk/src/bp-members/bp-members-template.php

Timestamp:

05/19/2016 03:46:29 AM (10 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.

File:

• trunk/src/bp-members/bp-members-template.php (modified) (6 diffs)

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 );