Changeset 13302 for trunk/src/bp-groups/bp-groups-template.php

Timestamp:

07/22/2022 11:44:14 AM (4 years ago)

Author:

imath

Message:

Introduce a function to only get the "Join/Leave Group" button args

bp_groups_get_group_join_button_args() eases the process of getting these arguments and removes the need for BP Nouveau's workaround.
Deprecate the bp_nouveau_groups_catch_button_args() as no more needed.

Props hnla

See #7126
See #8722

File:

• trunk/src/bp-groups/bp-groups-template.php (modified) (12 diffs)

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

@@ -3564 +3564 @@
         echo bp_get_group_join_button( $group );
 }
-        /**
-         * Return button to join a group.
-         *
-         * @since 1.0.0
-         *
-         * @param object|bool $group Single group object.
-         * @return false|string
-         */
-        function bp_get_group_join_button( $group = false ) {
-                global $groups_template;
-
-                // Set group to current loop group if none passed.
-                if ( empty( $group ) ) {
-                        $group =& $groups_template->group;
+
+        /**
+         * Get the arguments for the Join button group
+         *
+         * @since 11.0.0
+         *
+         * @param BP_Groups_Group $group The group object.
+         * @return Array The arguments for the Join button group
+         */
+        function bp_groups_get_group_join_button_args( $group = null ) {
+                $button_args = array();
+
+                if ( empty( $group->id ) ) {
+                        return $button_args;
                 }
 
                 // Don't show button if not logged in or previously banned.
                 if ( ! is_user_logged_in() || bp_group_is_user_banned( $group ) ) {
-                        return false;
+                        return $button_args;
                 }
 
                 // Group creation was not completed or status is unknown.
                 if ( empty( $group->status ) ) {
-                        return false;
+                        return $button_args;
                 }
 
@@ -3596 +3596 @@
                         $group_admins = groups_get_group_admins( $group->id );
                         if ( ( 1 == count( $group_admins ) ) && ( bp_loggedin_user_id() === (int) $group_admins[0]->user_id ) ) {
-                                return false;
+                                return $button_args;
                         }
 
                         // Setup button attributes.
-                        $button = array(
+                        $button_args = array(
                                 'id'                => 'leave_group',
                                 'component'         => 'groups',
@@ -3609 +3609 @@
                                 'link_href'         => wp_nonce_url( trailingslashit( bp_get_group_permalink( $group ) . 'leave-group' ), 'groups_leave_group' ),
                                 'link_text'         => __( 'Leave Group', 'buddypress' ),
+                                'link_title'        => __( 'Leave Group', 'buddypress' ),
                                 'link_class'        => 'group-button leave-group',
                         );
@@ -3618 +3619 @@
                         switch ( $group->status ) {
                                 case 'hidden' :
-                                        return false;
+                                        return $button_args;
 
                                 case 'public':
-                                        $button = array(
+                                        $button_args = array(
                                                 'id'                => 'join_group',
                                                 'component'         => 'groups',
@@ -3630 +3631 @@
                                                 'link_href'         => wp_nonce_url( trailingslashit( bp_get_group_permalink( $group ) . 'join' ), 'groups_join_group' ),
                                                 'link_text'         => __( 'Join Group', 'buddypress' ),
+                                                'link_title'        => __( 'Join Group', 'buddypress' ),
                                                 'link_class'        => 'group-button join-group',
                                         );
@@ -3639 +3641 @@
                                         // show an "Accept Invitation" button.
                                         if ( $group->is_invited ) {
-                                                $button = array(
+                                                $button_args = array(
                                                         'id'                => 'accept_invite',
                                                         'component'         => 'groups',
@@ -3648 +3650 @@
                                                         'link_href'         => add_query_arg( 'redirect_to', bp_get_group_permalink( $group ), bp_get_group_accept_invite_link( $group ) ),
                                                         'link_text'         => __( 'Accept Invitation', 'buddypress' ),
+                                                        'link_title'        => __( 'Accept Invitation', 'buddypress' ),
                                                         'link_class'        => 'group-button accept-invite',
                                                 );
@@ -3654 +3657 @@
                                         // show a "Request Sent" button.
                                         } elseif ( $group->is_pending ) {
-                                                $button = array(
+                                                $button_args = array(
                                                         'id'                => 'membership_requested',
                                                         'component'         => 'groups',
@@ -3663 +3666 @@
                                                         'link_href'         => bp_get_group_permalink( $group ),
                                                         'link_text'         => __( 'Request Sent', 'buddypress' ),
+                                                        'link_title'        => __( 'Request Sent', 'buddypress' ),
                                                         'link_class'        => 'group-button pending membership-requested',
                                                 );
@@ -3669 +3673 @@
                                         // show a "Request Membership" button.
                                         } else {
-                                                $button = array(
+                                                $button_args = array(
                                                         'id'                => 'request_membership',
                                                         'component'         => 'groups',
@@ -3678 +3682 @@
                                                         'link_href'         => wp_nonce_url( trailingslashit( bp_get_group_permalink( $group ) . 'request-membership' ), 'groups_request_membership' ),
                                                         'link_text'         => __( 'Request Membership', 'buddypress' ),
+                                                        'link_title'        => __( 'Request Membership', 'buddypress' ),
                                                         'link_class'        => 'group-button request-membership',
                                                 );
@@ -3687 +3692 @@
 
                 /**
-                 * Filters the HTML button for joining a group.
+                 * Filters the arguments of the button for joining a group.
                  *
                  * @since 1.2.6
                  * @since 2.4.0 Added $group parameter to filter args.
                  *
-                 * @param string $button HTML button for joining a group.
-                 * @param object $group BuddyPress group object
-                 */
-                return bp_get_button( apply_filters( 'bp_get_group_join_button', $button, $group ) );
+                 * @param array  $button_args The arguments for the button.
+                 * @param object $group       BuddyPress group object
+                 */
+                return apply_filters( 'bp_get_group_join_button', $button_args, $group );
+        }
+        /**
+         * Return button to join a group.
+         *
+         * @since 1.0.0
+         * @since 11.0.0 uses `bp_groups_get_group_join_button_args()`.
+         *
+         * @param object|bool $group Single group object.
+         * @return false|string
+         */
+        function bp_get_group_join_button( $group = false ) {
+                global $groups_template;
+
+                // Set group to current loop group if none passed.
+                if ( empty( $group ) ) {
+                        $group =& $groups_template->group;
+                }
+
+                $button_args = bp_groups_get_group_join_button_args( $group );
+
+                if ( ! array_filter( $button_args ) ) {
+                        return false;
+                }
+
+                return bp_get_button( $button_args );
         }