Changeset 13301 for trunk/src/bp-friends/bp-friends-template.php

Timestamp:

07/22/2022 10:50:40 AM (4 years ago)

Author:

imath

Message:

Introduce a function to only get the Friendship button arguments

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

Props hnla

See #7126
See #8722

File:

• trunk/src/bp-friends/bp-friends-template.php (modified) (10 diffs)

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

@@ -361 +361 @@
         echo bp_get_add_friend_button( $potential_friend_id, $friend_status );
 }
-        /**
-         * Create the Add Friend button.
-         *
-         * @since 1.1.0
-         *
-         * @param int  $potential_friend_id ID of the user to whom the button
-         *                                  applies. Default: value of {@link bp_get_potential_friend_id()}.
-         * @param bool $friend_status       Not currently used.
-         * @return bool|string HTML for the Add Friend button. False if already friends.
-         */
-        function bp_get_add_friend_button( $potential_friend_id = 0, $friend_status = false ) {
+
+        /**
+         * Build friend button arguments.
+         *
+         * @since 11.0.0
+         *
+         * @param int    $potential_friend_id The user ID of the potential friend.
+         * @return array The friend button arguments.
+         */
+        function bp_get_add_friend_button_args( $potential_friend_id = 0 ) {
+                $button_args = array();
 
                 if ( empty( $potential_friend_id ) ) {
@@ -377 +377 @@
                 }
 
-                $is_friend = bp_is_friend( $potential_friend_id );
-
-                if ( empty( $is_friend ) ) {
-                        return false;
-                }
-
-                switch ( $is_friend ) {
+                $friendship_status = bp_is_friend( $potential_friend_id );
+
+                if ( empty( $friendship_status ) ) {
+                        return $button_args;
+                }
+
+                switch ( $friendship_status ) {
                         case 'pending':
-                                $button = array(
+                                $button_args = array(
                                         'id'                => 'pending',
                                         'component'         => 'friends',
@@ -394 +394 @@
                                         'link_href'         => wp_nonce_url( bp_loggedin_user_domain() . bp_get_friends_slug() . '/requests/cancel/' . $potential_friend_id . '/', 'friends_withdraw_friendship' ),
                                         'link_text'         => __( 'Cancel Friendship Request', 'buddypress' ),
+                                        'link_title'        => __( 'Cancel Friendship Requested', 'buddypress' ),
                                         'link_id'           => 'friend-' . $potential_friend_id,
                                         'link_rel'          => 'remove',
@@ -401 +402 @@
 
                         case 'awaiting_response':
-                                $button = array(
+                                $button_args = array(
                                         'id'                => 'awaiting_response',
                                         'component'         => 'friends',
@@ -410 +411 @@
                                         'link_href'         => bp_loggedin_user_domain() . bp_get_friends_slug() . '/requests/',
                                         'link_text'         => __( 'Friendship Requested', 'buddypress' ),
+                                        'link_title'        => __( 'Friendship Requested', 'buddypress' ),
                                         'link_id'           => 'friend-' . $potential_friend_id,
                                         'link_rel'          => 'remove',
@@ -417 +419 @@
 
                         case 'is_friend':
-                                $button = array(
+                                $button_args = array(
                                         'id'                => 'is_friend',
                                         'component'         => 'friends',
@@ -426 +428 @@
                                         'link_href'         => wp_nonce_url( bp_loggedin_user_domain() . bp_get_friends_slug() . '/remove-friend/' . $potential_friend_id . '/', 'friends_remove_friend' ),
                                         'link_text'         => __( 'Cancel Friendship', 'buddypress' ),
+                                        'link_title'        => __( 'Cancel Friendship', 'buddypress' ),
                                         'link_id'           => 'friend-' . $potential_friend_id,
                                         'link_rel'          => 'remove',
@@ -433 +436 @@
 
                         default:
-                                $button = array(
+                                $button_args = array(
                                         'id'                => 'not_friends',
                                         'component'         => 'friends',
@@ -442 +445 @@
                                         'link_href'         => wp_nonce_url( bp_loggedin_user_domain() . bp_get_friends_slug() . '/add-friend/' . $potential_friend_id . '/', 'friends_add_friend' ),
                                         'link_text'         => __( 'Add Friend', 'buddypress' ),
+                                        'link_title'        => __( 'Add Friend', 'buddypress' ),
                                         'link_id'           => 'friend-' . $potential_friend_id,
                                         'link_rel'          => 'add',
@@ -454 +458 @@
                  * @since 1.1.0
                  *
-                 * @param string $button HTML markup for add friend button.
-                 */
-                return bp_get_button( apply_filters( 'bp_get_add_friend_button', $button ) );
+                 * @param string $button_args Button arguments for add friend button.
+                 */
+                return apply_filters( 'bp_get_add_friend_button', $button_args );
+        }
+
+        /**
+         * Create the Add Friend button.
+         *
+         * @since 1.1.0
+         * @since 11.0.0 uses `bp_get_add_friend_button_args()`.
+         *
+         * @param int  $potential_friend_id ID of the user to whom the button
+         *                                  applies. Default: value of {@link bp_get_potential_friend_id()}.
+         * @param bool $friend_status       Not currently used.
+         * @return bool|string HTML for the Add Friend button. False if already friends.
+         */
+        function bp_get_add_friend_button( $potential_friend_id = 0, $friend_status = false ) {
+                $button_args = bp_get_add_friend_button_args( $potential_friend_id );
+
+                if ( ! array_filter( $button_args ) ) {
+                        return false;
+                }
+
+                return bp_get_button( $button_args );
         }