Changeset 13432 for trunk/src/bp-core/bp-core-template.php

Timestamp:

03/01/2023 08:17:11 AM (3 years ago)

Author:

imath

Message:

BP Rewrites: introduce the bp_rewrites_get_url() function

Its role is to build every BuddyPress URL using the BP Rewrites API.

This commit also deprecates softly some key functions like bp_get_root_domain() to let us review (thanks to deprecated notices) all BuddyPress links during 12.0 development cycle and make them use the introduced bp_rewrites_get_url() function or a wrapper of it. Once all replacements achieved, we'll need to fully deprecate:

• bp_get_root_domain()
• bp_root_domain()
• bp_core_get_root_domain()

Slug constants have also been completely deprecated as we will be able to customize every slugs from the future "URL" tab of the BuddyPress settings page.

The $bp->root_domain BuddyPress global has been deprecated in favor of $bp->root_url.

Finally, the Components $rewrite_ids properties are now in place and corresponding rewrite rules are successfully generated.

Props r-a-y, johnjamesjacoby, boonebgorges

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

File:

• trunk/src/bp-core/bp-core-template.php (modified) (2 diffs)

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

@@ -1400 +1400 @@
 
 /**
+ * Gets the BP root blog's URL.
+ *
+ * @since 12.0.0
+ *
+ * @return string The BP root blog's URL.
+ */
+function bp_get_root_url() {
+    $bp = buddypress();
+
+    if ( ! empty( $bp->root_url ) ) {
+        $url = $bp->root_url;
+    } else {
+        $url          = bp_rewrites_get_root_url();
+        $bp->root_url = $url;
+    }
+
+    /**
+     * Filters the "root url", the URL of the BP root blog.
+     *
+     * @since 12.0.0
+     *
+     * @param string $url URL of the BP root blog.
+     */
+    return apply_filters( 'bp_get_root_url', $url );
+}
+
+/**
+ * Output the "root url", the URL of the BP root blog.
+ *
+ * @since 12.0.0
+ */
+function bp_root_url() {
+    echo esc_url( bp_get_root_url() );
+}
+
+/**
  * Output the "root domain", the URL of the BP root blog.
  *
  * @since 1.1.0
+ * @deprecated 12.0.0
  */
 function bp_root_domain() {
-    echo bp_get_root_domain();
+    _deprecated_function( __FUNCTION__, '12.0.0', 'bp_root_url()' );
+    bp_root_url();
 }
     /**
@@ -1411 +1449 @@
      *
      * @since 1.1.0
+     * @deprecated 12.0.0
      *
      * @return string URL of the BP root blog.
      */
     function bp_get_root_domain() {
-        $bp = buddypress();
-
-        if ( ! empty( $bp->root_domain ) ) {
-            $domain = $bp->root_domain;
-        } else {
-            $domain          = bp_core_get_root_domain();
-            $bp->root_domain = $domain;
-        }
+        /*
+         * This function is used at many places and we need to review all this
+         * places during the 12.0 development cycle. Using BP Rewrites means we
+         * cannot concatenate URL chunks to build our URL anymore. We now need
+         * to use `bp_rewrites_get_url( $array )` and make sure to use the right
+         * arguments inside this `$array`.
+         *
+         * @todo Once every link reviewed, we'll be able to remove this check
+         *       and let PHPUnit tell us the one we forgot, eventually!
+         */
+        if ( ! buddypress()->is_phpunit_running ) {
+            _deprecated_function( __FUNCTION__, '12.0.0', 'bp_get_root_url()' );
+        }
+
+        $domain = bp_get_root_url();
 
         /**
-         * Filters the "root domain", the URL of the BP root blog.
+         *  Filters the "root domain", the URL of the BP root blog.
          *
          * @since 1.2.4
+         * @deprecated 12.0.0 Use {@see 'bp_get_root_url'} instead.
          *
          * @param string $domain URL of the BP root blog.
          */
-        return apply_filters( 'bp_get_root_domain', $domain );
+        return apply_filters_deprecated( 'bp_core_get_root_domain', array( $domain ), '12.0.0', 'bp_get_root_url' );
     }