Ticket #6749: 6749-4.diff

src/bp-groups/bp-groups-template.php

@@ -2764 +2764 @@
  * Output a URL for demoting a user to member.
  *
  * @since 1.0.0
+ * @since 10.0.0 Added the `$group` paremeter.
  *
- * @param int $user_id ID of the member to demote. Default: current member in
- *                     a member loop.
+ * @param int                              $user_id ID of the member to demote. Default: 0.
+ * @param false|int|string|BP_Groups_Group $group   (Optional) The Group ID, the Group Slug or the Group object.
+ *                                                  Default: false.
  */
-function bp_group_member_demote_link( $user_id = 0 ) {
-        global $members_template;
-
-        if ( !$user_id ) {
-                $user_id = $members_template->member->user_id;
-        }
-
-        echo bp_get_group_member_demote_link( $user_id );
+function bp_group_member_demote_link( $user_id = 0, $group = false ) {
+        echo bp_get_group_member_demote_link( $user_id, $group );
 }
         /**
          * Generate a URL for demoting a user to member.
          *
          * @since 1.0.0
+         * @since 10.0.0 Updated to use `bp_get_group`.
          *
-         * @param int         $user_id ID of the member to demote. Default: current
-         *                             member in a member loop.
-         * @param object|bool $group   Optional. Group object. Default: current group.
+         * @param int                              $user_id ID of the member to demote. Default: 0.
+         * @param false|int|string|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
+     *                                                Default: false.
          * @return string
          */
         function bp_get_group_member_demote_link( $user_id = 0, $group = false ) {
-                global $members_template, $groups_template;
+                global $members_template;
 
-                if ( empty( $group ) ) {
-                        $group =& $groups_template->group;
+                $group = bp_get_group( $group );
+
+                if ( empty( $group->id ) ) {
+                        return '';
                 }
 
-                if ( !$user_id ) {
+                if ( ! $user_id ) {
                         $user_id = $members_template->member->user_id;
                 }
 
@@ -2802 +2801 @@
                  * Filters a URL for demoting a user to member.
                  *
                  * @since 1.0.0
-                 * @since 2.5.0 Added the `$group` parameter.
+                 * @since 2.5.0  Added the `$group` parameter.
+                 * @since 10.0.0 Added the `$user_id` parameter.
                  *
-                 * @param string $value URL to use for demoting a user to member.
-                 * @param object $group Group object.
+                 * @param string          $value   URL to use for demoting a user to member.
+                 * @param BP_Groups_Group $group   The group object.
+                 * @param int             $user_id The user ID.
                  */
-                return apply_filters( 'bp_get_group_member_demote_link', wp_nonce_url( trailingslashit( bp_get_group_permalink( $group ) . 'admin/manage-members/demote/' . $user_id ), 'groups_demote_member' ), $group );
+                return apply_filters(
+                        'bp_get_group_member_demote_link',
+                        wp_nonce_url( trailingslashit( bp_get_group_permalink( $group ) . 'admin/manage-members/demote/' . $user_id ), 'groups_demote_member' ),
+                        $group,
+                        $user_id
+                );
         }
 
 /**
  * Output a URL for banning a member from a group.
  *
  * @since 1.0.0
+ * @since 10.0.0 Added the `$group` paremeter.
  *
- * @param int $user_id ID of the member to ban.
- *                     Default: current member in a member loop.
+ * @param int                              $user_id ID of the member. Default: 0.
+ * @param false|int|string|BP_Groups_Group $group   (Optional) The Group ID, the Group Slug or the Group object.
+ *                                                  Default: false.
  */
-function bp_group_member_ban_link( $user_id = 0 ) {
-        global $members_template;
-
-        if ( !$user_id ) {
-                $user_id = $members_template->member->user_id;
-        }
-
-        echo bp_get_group_member_ban_link( $user_id );
+function bp_group_member_ban_link( $user_id = 0, $group = false ) {
+        echo bp_get_group_member_ban_link( $user_id, $group );
 }
         /**
          * Generate a URL for banning a member from a group.
          *
          * @since 1.0.0
+         * @since 10.0.0 Updated to use `bp_get_group`.
          *
-         * @param int         $user_id ID of the member to ban.
-         *                             Default: current member in a member loop.
-         * @param object|bool $group   Optional. Group object. Default: current group.
+         * @param int                              $user_id ID of the member to ban. Default: 0.
+         * @param false|int|string|BP_Groups_Group $group   (Optional) The Group ID, the Group Slug or the Group object.
+     *                                                  Default: false.
          * @return string
          */
         function bp_get_group_member_ban_link( $user_id = 0, $group = false ) {
-                global $groups_template;
+                global $members_template;
 
-                if ( empty( $group ) ) {
-                        $group =& $groups_template->group;
+                $group = bp_get_group( $group );
+
+                if ( empty( $group->id ) ) {
+                        return '';
+                }
+
+                if ( ! $user_id ) {
+                        $user_id = $members_template->member->user_id;
                 }
 
                 /**
                  * Filters a URL for banning a member from a group.
                  *
                  * @since 1.0.0
+                 * @since 10.0.0 Added the `$group`and `$user_id` parameter.
                  *
-                 * @param string $value URL to use for banning a member.
+                 * @param string          $value   URL to use for banning a member.
+                 * @param BP_Groups_Group $group   The group object.
+                 * @param int             $user_id The user ID.
                  */
-                return apply_filters( 'bp_get_group_member_ban_link', wp_nonce_url( trailingslashit( bp_get_group_permalink( $group ) . 'admin/manage-members/ban/' . $user_id ), 'groups_ban_member' ) );
+                return apply_filters(
+                        'bp_get_group_member_ban_link',
+                        wp_nonce_url( trailingslashit( bp_get_group_permalink( $group ) . 'admin/manage-members/ban/' . $user_id ), 'groups_ban_member' ),
+                        $group,
+                        $user_id
+                );
         }
 
 /**
  * Output a URL for unbanning a member from a group.
  *
  * @since 1.0.0
+ * @since 10.0.0 Added the `$group` paremeter.
  *
- * @param int $user_id ID of the member to unban.
- *                     Default: current member in a member loop.
+ * @param int                              $user_id ID of the member to unban. Default: 0.
+ * @param false|int|string|BP_Groups_Group $group   (Optional) The Group ID, the Group Slug or the Group object.
+ *                                                  Default: false.
  */
-function bp_group_member_unban_link( $user_id = 0 ) {
-        global $members_template;
-
-        if ( !$user_id ) {
-                $user_id = $members_template->member->user_id;
-        }
-
-        echo bp_get_group_member_unban_link( $user_id );
+function bp_group_member_unban_link( $user_id = 0, $group = false ) {
+        echo bp_get_group_member_unban_link( $user_id, $group );
 }
         /**
          * Generate a URL for unbanning a member from a group.
          *
          * @since 1.0.0
+         * @since 10.0.0 Updated to use `bp_get_group`.
          *
-         * @param int         $user_id ID of the member to unban.
-         *                             Default: current member in a member loop.
-         * @param object|bool $group   Optional. Group object. Default: current group.
+         * @param int                              $user_id ID of the member to unban. Default: 0.
+         * @param false|int|string|BP_Groups_Group $group   (Optional) The Group ID, the Group Slug or the Group object.
+     *                                                  Default: false.
          * @return string
          */
         function bp_get_group_member_unban_link( $user_id = 0, $group = false ) {
-                global $members_template, $groups_template;
+                global $members_template;
 
-                if ( !$user_id ) {
-                        $user_id = $members_template->member->user_id;
+                $group = bp_get_group( $group );
+
+                if ( empty( $group->id ) ) {
+                        return '';
                 }
 
-                if ( empty( $group ) ) {
-                        $group =& $groups_template->group;
+                if ( ! $user_id ) {
+                        $user_id = $members_template->member->user_id;
                 }
 
                 /**
                  * Filters a URL for unbanning a member from a group.
                  *
                  * @since 1.0.0
+                 * @since 10.0.0 Added the `$group`and `$user_id` parameter.
                  *
-                 * @param string $value URL to use for unbanning a member.
+                 * @param string          $value   URL to use for unbanning a member.
+                 * @param BP_Groups_Group $group   The group object.
+                 * @param int             $user_id The user ID.
                  */
-                return apply_filters( 'bp_get_group_member_unban_link', wp_nonce_url( trailingslashit( bp_get_group_permalink( $group ) . 'admin/manage-members/unban/' . $user_id ), 'groups_unban_member' ) );
+                return apply_filters(
+                        'bp_get_group_member_unban_link',
+                        wp_nonce_url( trailingslashit( bp_get_group_permalink( $group ) . 'admin/manage-members/unban/' . $user_id ), 'groups_unban_member' ),
+                        $group,
+                        $user_id
+                );
         }
 
 /**
  * Output a URL for removing a member from a group.
  *
  * @since 1.2.6
+ * @since 10.0.0 Added the `$group` paremeter.
  *
- * @param int $user_id ID of the member to remove.
- *                     Default: current member in a member loop.
+ * @param int                              $user_id ID of the member to remove. Default: 0.
+ * @param false|int|string|BP_Groups_Group $group   (Optional) The Group ID, the Group Slug or the Group object.
+ *                                                  Default: false.
  */
-function bp_group_member_remove_link( $user_id = 0 ) {
-        global $members_template;
-
-        if ( !$user_id ) {
-                $user_id = $members_template->member->user_id;
-        }
-
-        echo bp_get_group_member_remove_link( $user_id );
+function bp_group_member_remove_link( $user_id = 0, $group = false ) {
+        echo bp_get_group_member_remove_link( $user_id, $group );
 }
         /**
          * Generate a URL for removing a member from a group.
          *
          * @since 1.2.6
+         * @since 10.0.0 Updated to use `bp_get_group`.
          *
-         * @param int         $user_id ID of the member to remove.
-         *                             Default: current member in a member loop.
-         * @param object|bool $group   Optional. Group object. Default: current group.
+         * @param int                              $user_id ID of the member to remove. Default: 0.
+         * @param false|int|string|BP_Groups_Group $group   (Optional) The Group ID, the Group Slug or the Group object.
+     *                                                  Default: false.
          * @return string
          */
         function bp_get_group_member_remove_link( $user_id = 0, $group = false ) {
-                global $groups_template;
+                global $members_template;
 
-                if ( empty( $group ) ) {
-                        $group =& $groups_template->group;
+                $group = bp_get_group( $group );
+
+                if ( empty( $group->id ) ) {
+                        return '';
+                }
+
+                if ( ! $user_id ) {
+                        $user_id = $members_template->member->user_id;
                 }
 
                 /**
                  * Filters a URL for removing a member from a group.
                  *
                  * @since 1.2.6
-                 * @since 2.5.0 Added the `$group` parameter.
+                 * @since 2.5.0  Added the `$group` parameter.
+                 * @since 10.0.0 Added the `$user_id` parameter.
                  *
-                 * @param string $value URL to use for removing a member.
-                 * @param object $group Group object.
+                 * @param string          $value   URL to use for removing a member.
+                 * @param BP_Groups_Group $group   The group object.
+                 * @param int             $user_id The user ID.
                  */
-                return apply_filters( 'bp_get_group_member_remove_link', wp_nonce_url( trailingslashit( bp_get_group_permalink( $group ) . 'admin/manage-members/remove/' . $user_id ), 'groups_remove_member' ), $group );
+                return apply_filters(
+                        'bp_get_group_member_remove_link',
+                        wp_nonce_url( trailingslashit( bp_get_group_permalink( $group ) . 'admin/manage-members/remove/' . $user_id ), 'groups_remove_member' ),
+                        $group,
+                        $user_id
+                );
         }
 
 /**
@@ -3040 +3074 @@
  * Output the 'action' attribute for a group form.
  *
  * @since 1.0.0
+ * @since 10.0.0 Added the `$group` paremeter.
  *
- * @param string $page Page slug.
+ * @param string                           $page  Page slug.
+ * @param false|int|string|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
+ *                                                Default: false.
  */
-function bp_group_form_action( $page ) {
-        echo bp_get_group_form_action( $page );
+function bp_group_form_action( $page, $group = false ) {
+        echo bp_get_group_form_action( $page, $group );
 }
         /**
          * Generate the 'action' attribute for a group form.
          *
          * @since 1.0.0
+         * @since 10.0.0 Updated to use `bp_get_group`.
          *
-         * @param string      $page  Page slug.
-         * @param object|bool $group Optional. Group object.
-         *                           Default: current group in the loop.
+         * @param string                           $page  Page slug.
+         * @param false|int|string|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
+     *                                                Default: false.
          * @return string
          */
         function bp_get_group_form_action( $page, $group = false ) {
-                global $groups_template;
+                $group = bp_get_group( $group );
 
-                if ( empty( $group ) ) {
-                        $group =& $groups_template->group;
+                if ( empty( $group->id ) || empty( $page ) ) {
+                        return '';
                 }
 
                 /**
@@ -3069 +3107 @@
                  * @since 1.0.0
                  * @since 2.5.0 Added the `$group` parameter.
                  *
-                 * @param string $value Action attribute for a group form.
-                 * @param object $group Group object.
+                 * @param string          $value Action attribute for a group form.
+                 * @param BP_Groups_Group $group The group object.
+                 * @param int|string|bool $page  Page slug.
                  */
-                return apply_filters( 'bp_group_form_action', trailingslashit( bp_get_group_permalink( $group ) . $page ), $group );
+                return apply_filters( 'bp_group_form_action', trailingslashit( bp_get_group_permalink( $group ) . $page ), $group, $page );
         }
 
 /**
  * Output the 'action' attribute for a group admin form.
  *
  * @since 1.0.0
+ * @since 10.0.0 Added the `$group` paremeter.
  *
- * @param string|bool $page Optional. Page slug.
+ * @param false|string|bool                $page  (Optional). Page slug. Default: false.
+ * @param false|int|string|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
+ *                                                Default: false.
  */
-function bp_group_admin_form_action( $page = false ) {
-        echo bp_get_group_admin_form_action( $page );
+function bp_group_admin_form_action( $page = false, $group = false ) {
+        echo bp_get_group_admin_form_action( $page, $group );
 }
         /**
          * Generate the 'action' attribute for a group admin form.
          *
          * @since 1.0.0
+         * @since 10.0.0 Updated to use `bp_get_group`.
          *
-         * @param string|bool $page  Optional. Page slug.
-         * @param object|bool $group Optional. Group object.
-         *                           Default: current group in the loop.
+         * @param false|string|bool                $page  (Optional). Page slug. Default: false.
+         * @param false|int|string|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
+     *                                                Default: false.
          * @return string
          */
         function bp_get_group_admin_form_action( $page = false, $group = false ) {
-                global $groups_template;
+                $group = bp_get_group( $group );
 
-                if ( empty( $group ) ) {
-                        $group =& $groups_template->group;
+                if ( empty( $group->id ) ) {
+                        return '';
                 }
 
                 if ( empty( $page ) ) {
@@ -3110 +3153 @@
                  * Filters the 'action' attribute for a group admin form.
                  *
                  * @since 1.0.0
-                 * @since 2.5.0 Added the `$group` parameter.
+                 * @since 2.5.0  Added the `$group` parameter.
+                 * @since 10.0.0 Added the `$page` parameter.
                  *
-                 * @param string $value Action attribute for a group admin form.
-                 * @param object $group Group object.
+                 * @param string          $value Action attribute for a group admin form.
+                 * @param BP_Groups_Group $group The group object.
+                 * @param int|string|bool $page  Page slug.
                  */
-                return apply_filters( 'bp_group_admin_form_action', trailingslashit( bp_get_group_permalink( $group ) . 'admin/' . $page ), $group );
+                return apply_filters( 'bp_group_admin_form_action', trailingslashit( bp_get_group_permalink( $group ) . 'admin/' . $page ), $group, $page );
         }
 
 /**
  * Determine whether the logged-in user has requested membership to a group.
  *
  * @since 1.0.0
+ * @since 10.0.0 Updated to use `bp_get_group`.
  *
- * @param object|bool $group Optional. Group object.
- *                           Default: current group in the loop.
+ * @param false|int|string|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
+ *                                                Default: false.
  * @return bool
  */
 function bp_group_has_requested_membership( $group = false ) {
-        global $groups_template;
-
-        if ( empty( $group ) ) {
-                $group =& $groups_template->group;
-        }
+        $group = bp_get_group( $group );
 
-        if ( groups_check_for_membership_request( bp_loggedin_user_id(), $group->id ) ) {
-                return true;
+        if ( empty( $group->id ) ) {
+                return false;
         }
 
-        return false;
+        return ( groups_check_for_membership_request( bp_loggedin_user_id(), $group->id ) );
 }
 
 /**
@@ -3662 +3704 @@
                  *
                  * @since 2.0.0
                  *
-                 * @param string $button HTML button for creating a group.
+                 * @param array $button_args HTML button for creating a group.
                  */
-                return bp_get_button( apply_filters( 'bp_get_group_create_button', $button_args ) );
+                $button_args = apply_filters( 'bp_get_group_create_button', $button_args );
+
+                return bp_get_button( $button_args );
         }
 
 /**
@@ -3675 +3719 @@
 function bp_group_create_nav_item() {
         echo bp_get_group_create_nav_item();
 }
-
         /**
          * Get the Create a Group nav item.
          *
@@ -3839 +3882 @@
                  *
                  * @param int $value Total number of groups found.
                  */
-                return apply_filters( 'bp_get_total_group_count', groups_get_total_group_count() );
+                return apply_filters( 'bp_get_total_group_count', (int) groups_get_total_group_count() );
         }
 
 /**
@@ -4112 +4155 @@
 function bp_group_member_name() {
         echo bp_get_group_member_name();
 }
-
         /**
          * @since 1.0.0
          *
@@ -4137 +4179 @@
 function bp_group_member_url() {
         echo bp_get_group_member_url();
 }
-
         /**
          * @since 1.0.0
          *
@@ -4162 +4203 @@
 function bp_group_member_link() {
         echo bp_get_group_member_link();
 }
-
         /**
          * @since 1.0.0
          *
@@ -4187 +4227 @@
 function bp_group_member_domain() {
         echo bp_get_group_member_domain();
 }
-
         /**
          * @since 1.2.0
          *
@@ -4212 +4251 @@
 function bp_group_member_is_friend() {
         echo bp_get_group_member_is_friend();
 }
-
         /**
          * @since 1.2.0
          *
@@ -4240 +4278 @@
         }
 
 /**
+ * Check whether the member is banned from the current group.
+ *
  * @since 1.0.0
  */
 function bp_group_member_is_banned() {
         echo bp_get_group_member_is_banned();
 }
-
         /**
+         * Check whether the member is banned from the current group.
+         *
          * @since 1.0.0
          *
-         * @return mixed|void
+         * @return bool
          */
         function bp_get_group_member_is_banned() {
                 global $members_template;
 
+                if ( ! isset( $members_template->member->is_banned ) ) {
+                        return false;
+                }
+
                 /**
                  * Filters whether the member is banned from the current group.
                  *
@@ -4261 +4306 @@
                  *
                  * @param bool $is_banned Whether or not the member is banned.
                  */
-                return apply_filters( 'bp_get_group_member_is_banned', $members_template->member->is_banned );
+                return apply_filters( 'bp_get_group_member_is_banned', (bool) $members_template->member->is_banned );
         }
 
 /**
+ * Output CSS if group member is banned.
+ *
  * @since 1.2.6
+ * @since 10.0.0 Updated to use `bp_get_group_member_is_banned`.
  */
 function bp_group_member_css_class() {
-        global $members_template;
-
-        if ( $members_template->member->is_banned ) {
+        if ( bp_get_group_member_is_banned() ) {
 
                 /**
                  * Filters the class to add to the HTML if member is banned.
@@ -4340 +4386 @@
         }
 
 /**
+ * Get group member from current group.
+ *
  * @since 1.0.0
  */
 function bp_group_member_id() {
         echo bp_get_group_member_id();
 }
-
         /**
+         * Get group member from current group.
+         *
          * @since 1.0.0
          *
-         * @return mixed|void
+         * @return int
          */
         function bp_get_group_member_id() {
                 global $members_template;
 
+                if ( ! isset( $members_template->member->user_id ) ) {
+                        return 0;
+                }
+
                 /**
                  * Filters the member's user ID for group members loop.
                  *
@@ -4361 +4414 @@
                  *
                  * @param int $user_id User ID of the member.
                  */
-                return apply_filters( 'bp_get_group_member_id', $members_template->member->user_id );
+                return apply_filters( 'bp_get_group_member_id', (int) $members_template->member->user_id );
         }
 
 /**
@@ -4372 +4425 @@
 function bp_group_member_needs_pagination() {
         global $members_template;
 
-        if ( $members_template->total_member_count > $members_template->pag_num ) {
-                return true;
-        }
-
-        return false;
+        return ( $members_template->total_member_count > $members_template->pag_num );
 }
 
 /**
@@ -4385 +4434 @@
 function bp_group_pag_id() {
         echo bp_get_group_pag_id();
 }
-
         /**
          * @since 1.0.0
          *
@@ -4410 +4458 @@
         echo bp_get_group_member_pagination();
         wp_nonce_field( 'bp_groups_member_list', '_member_pag_nonce' );
 }
-
         /**
          * @since 1.0.0
          *
@@ -4435 +4482 @@
 function bp_group_member_pagination_count() {
         echo bp_get_group_member_pagination_count();
 }
-
         /**
          * @since 1.0.0
          *
@@ -4476 +4522 @@
         echo bp_get_group_member_admin_pagination();
         wp_nonce_field( 'bp_groups_member_admin_list', '_member_admin_pag_nonce' );
 }
-
         /**
          * @since 1.0.0
          *

tests/phpunit/testcases/groups/template.php

@@ -977 +977 @@
                 $this->assertTrue( bp_group_is_forum_enabled( $g2 ) );
         }
 
+        /**
+         * @group bp_get_group_member_is_banned
+         */
+        public function test_bp_group_member_is_banned() {
+                $this->assertFalse( bp_get_group_member_is_banned() );
+        }
+
+        /**
+         * @group bp_get_group_member_id
+         */
+        public function test_bp_get_group_member_id() {
+                $this->assertFalse( (bool) bp_get_group_member_id() );
+        }
+
+        /**
+         * @group bp_get_group_form_action
+         */
+        public function test_bp_bp_get_group_form_action_when_empty() {
+                $this->assertEmpty( bp_get_group_form_action( '' ) );
+        }
+
+        /**
+         * @group bp_get_group_form_action
+         */
+        public function test_bp_bp_get_group_form_action() {
+                $g   = $this->factory->group->create();
+                $p   = 2;
+                $url = trailingslashit( bp_get_group_permalink( $g ) . $p );
+
+                $this->assertSame( bp_get_group_form_action( $p, $g ), $url );
+        }
+
         /**
          * @group bp_get_group_member_count
          */