Changeset 13432 for trunk/src/bp-blogs/classes/class-bp-blogs-component.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-blogs/classes/class-bp-blogs-component.php (modified) (3 diffs)

trunk/src/bp-blogs/classes/class-bp-blogs-component.php

@@ -44 +44 @@
      * Set up global settings for the blogs component.
      *
-     * The BP_BLOGS_SLUG constant is deprecated, and only used here for
-     * backwards compatibility.
+     * The BP_BLOGS_SLUG constant is deprecated.
      *
      * @since 1.5.0
@@ -54 +53 @@
      */
     public function setup_globals( $args = array() ) {
-        $bp = buddypress();
-
-        if ( ! defined( 'BP_BLOGS_SLUG' ) ) {
-            define ( 'BP_BLOGS_SLUG', $this->id );
+        $bp           = buddypress();
+        $default_slug = $this->id;
+
+        // @deprecated.
+        if ( defined( 'BP_BLOGS_SLUG' ) ) {
+            _doing_it_wrong( 'BP_BLOGS_SLUG', esc_html__( 'Slug constants are deprecated.', 'buddypress' ), 'BuddyPress 12.0.0' );
+            $default_slug = BP_BLOGS_SLUG;
         }
 
@@ -76 +78 @@
         // All globals for blogs component.
         $args = array(
-            'slug'                  => BP_BLOGS_SLUG,
-            'root_slug'             => isset( $bp->pages->blogs->slug ) ? $bp->pages->blogs->slug : BP_BLOGS_SLUG,
+            'slug'                  => $default_slug,
+            'root_slug'             => isset( $bp->pages->blogs->slug ) ? $bp->pages->blogs->slug : $default_slug,
             'has_directory'         => is_multisite(), // Non-multisite installs don't need a top-level Sites directory, since there's only one site.
+            'rewrite_ids'           => array(
+                'directory'                    => 'blogs',
+                'single_item_action'           => 'blogs_action',
+                'single_item_action_variables' => 'blogs_action_variables',
+            ),
             'directory_title'       => isset( $bp->pages->blogs->title ) ? $bp->pages->blogs->title : $default_directory_title,
             'notification_callback' => 'bp_blogs_format_notifications',