Changeset 13433 for trunk/src/bp-members/bp-members-functions.php

Timestamp:

03/07/2023 04:28:08 AM (2 years ago)

Author:

imath

Message:

BP Rewrites: Introduce the bp_members_get_user_url() function

As many member URLs are built concatenating bp_core_get_user_domain()
with URL chunks, the safer way to make sure developers update the way they
build their member URLs in favor of using BP Rewrites is:

1. to deprecate this function
2. create a new function bp_members_get_user_url() which is a wrapper of

bp_rewrites_get_url()

3. replace all bp_core_get_user_domain() occurrences by

bp_members_get_user_url()

This commit also deprecates bp_core_get_username() in favor of the new
bp_members_get_user_slug() function and updates PHPUnit tests.

Props r-a-y, johnjamesjacoby, boonebgorges

Closes ​https://github.com/buddypress/buddypress/pull/70
See #4954

File:

• trunk/src/bp-members/bp-members-functions.php (modified) (7 diffs)

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

@@ -140 +140 @@
 
 /**
- * Return the domain for the passed user: e.g. http://example.com/members/andy/.
- *
- * @since 1.0.0
- *
- * @param int         $user_id       The ID of the user.
- * @param string|bool $user_nicename Optional. user_nicename of the user.
- * @param string|bool $user_login    Optional. user_login of the user.
- * @return string
- */
-function bp_core_get_user_domain( $user_id = 0, $user_nicename = false, $user_login = false ) {
-
-    if ( empty( $user_id ) ) {
-        return;
-    }
-
-    $username = bp_core_get_username( $user_id, $user_nicename, $user_login );
-
-    if ( bp_is_username_compatibility_mode() ) {
-        $username = rawurlencode( $username );
-    }
-
-    $after_domain = bp_core_enable_root_profiles() ? $username : bp_get_members_root_slug() . '/' . $username;
-    $domain       = trailingslashit( bp_get_root_domain() . '/' . $after_domain );
-
-    // Don't use this filter.  Subject to removal in a future release.
-    // Use the 'bp_core_get_user_domain' filter instead.
-    $domain = apply_filters( 'bp_core_get_user_domain_pre_cache', $domain, $user_id, $user_nicename, $user_login );
+ * Return the Mmbers single item's URL.
+ *
+ * @since 12.0.0
+ *
+ * @param integer $user_id  The user ID.
+ * @param array   $action {
+ *     An array of arguments. Optional.
+ *
+ *     @type string $single_item_component        The component slug the action is relative to.
+ *     @type string $single_item_action           The slug of the action to perform.
+ *     @type array  $single_item_action_variables An array of additional informations about the action to perform.
+ * }
+ * @return string The URL built for the BP Rewrites URL parser.
+ */
+function bp_members_get_user_url( $user_id = 0, $path_chunks = array() ) {
+    $url  = '';
+    $slug = bp_members_get_user_slug( $user_id );
+
+    if ( $slug ) {
+        if ( bp_is_username_compatibility_mode() ) {
+            $slug = rawurlencode( $slug );
+        }
+
+        $supported_chunks = array_fill_keys( array( 'single_item_component', 'single_item_action', 'single_item_action_variables' ), true );
+        $path_chunks      = bp_parse_args(
+            array_intersect_key( $path_chunks, $supported_chunks ),
+            array(
+                'component_id' => 'members',
+                'single_item'  => $slug,
+            )
+        );
+
+        $url = bp_rewrites_get_url( $path_chunks );
+    }
 
     /**
@@ -172 +179 @@
      *
      * @since 1.0.1
+     * @deprecated 12.0.0
      *
      * @param string $domain        Domain for the passed user.
@@ -178 +186 @@
      * @param string $user_login    User login of the passed user.
      */
-    return apply_filters( 'bp_core_get_user_domain', $domain, $user_id, $user_nicename, $user_login );
+    $url = apply_filters_deprecated( 'bp_core_get_user_domain', array( $url, $user_id, false, false ), '12.0.0', 'bp_members_get_user_url' );
+
+    /**
+     * Filters the domain for the passed user.
+     *
+     * @since 12.0.0
+     *
+     * @param string  $url      The user url.
+     * @param integer $user_id  The user ID.
+     * @param string  $slug     The user slug.
+     * @param array   $path_chunks {
+     *     An array of arguments. Optional.
+     *
+     *     @type string $single_item_component        The component slug the action is relative to.
+     *     @type string $single_item_action           The slug of the action to perform.
+     *     @type array  $single_item_action_variables An array of additional informations about the action to perform.
+     * }
+     */
+    return apply_filters( 'bp_members_get_user_url', $url, $user_id, $slug, $path_chunks );
 }
 
@@ -274 +300 @@
 
 /**
- * Return the username for a user based on their user id.
- *
- * This function is sensitive to the BP_ENABLE_USERNAME_COMPATIBILITY_MODE,
- * so it will return the user_login or user_nicename as appropriate.
- *
- * @since 1.0.0
- *
- * @param int         $user_id       User ID to check.
- * @param string|bool $user_nicename Optional. user_nicename of user being checked.
- * @param string|bool $user_login    Optional. user_login of user being checked.
- * @return string The username of the matched user or an empty string if no user is found.
- */
-function bp_core_get_username( $user_id = 0, $user_nicename = false, $user_login = false ) {
-
-    if ( ! $user_nicename && ! $user_login ) {
-        // Pull an audible and maybe use the login over the nicename.
-        if ( bp_is_username_compatibility_mode() ) {
-            $username = get_the_author_meta( 'login', $user_id );
-        } else {
-            $username = get_the_author_meta( 'nicename', $user_id );
-        }
+ * Returns the members single item (member) slug.
+ *
+ * @since 12.0.0
+ *
+ * @param integer $user_id The User ID.
+ * @return string The member slug.
+ */
+function bp_members_get_user_slug( $user_id = 0 ) {
+    $bp  = buddypress();
+    $lug = '';
+
+    $prop = 'user_nicename';
+    if ( bp_is_username_compatibility_mode() ) {
+        $prop = 'user_login';
+    }
+
+    if ( (int) bp_loggedin_user_id() === (int) $user_id ) {
+        $slug = isset( $bp->loggedin_user->userdata->{$prop} ) ? $bp->loggedin_user->userdata->{$prop} : null;
+    } elseif ( (int) bp_displayed_user_id() === (int) $user_id ) {
+        $slug = isset( $bp->displayed_user->userdata->{$prop} ) ? $bp->displayed_user->userdata->{$prop} : null;
     } else {
-        $username = bp_is_username_compatibility_mode() ? $user_login : $user_nicename;
+        $user = get_user_by( 'id', $user_id );
+
+        if ( $user instanceof WP_User ) {
+            $slug = $user->{$prop};
+        }
     }
 
@@ -303 +332 @@
      *
      * @since 1.0.1
-     *
-     * @param string $username Username determined by user ID.
-     */
-    return apply_filters( 'bp_core_get_username', $username );
+     * @deprecated 12.0.0
+     *
+     * @param string $slug Username determined by user ID.
+     */
+    $slug = apply_filters_deprecated( 'bp_core_get_username', array( $slug ), '12.0.0', 'bp_members_get_user_slug' );
+
+    /**
+     * Filter here to edit the user's slug.
+     *
+     * @since 12.0.0
+     *
+     * @param string $slug     The user's slug.
+     * @param integer $user_id The user ID.
+     */
+    return apply_filters( 'bp_members_get_user_slug', $slug, $user_id );
 }
 
@@ -381 +421 @@
     }
 
-    if ( !$url = bp_core_get_user_domain( $user_id ) ) {
+    if ( !$url = bp_members_get_user_url( $user_id ) ) {
         return false;
     }
@@ -3316 +3356 @@
     }
 
-    $profile_url = bp_core_get_user_domain( $user_id );
+    $profile_url = bp_members_get_user_url( $user_id );
 
     /**