Changeset 14011

Timestamp:

08/29/2024 12:29:00 AM (6 weeks ago)

Author:

imath

Message:

Add 2 new filterable functions to get register/activate root slugs

These 2 functions are used to set rewrite rules and permastructs for registration and activation pages.

Using the provided filters it is now possible to prepend a custom-slug/ to these generated rewrite rules and permastructs. This was the only missing thing to be able to prepend a custom-slug/ to all BP directory/specific page root slugs.

Props espellcaste, slaFFik, dcavins.

See #9063
Closes ​https://github.com/buddypress/buddypress/pull/364

Location:

trunk

Files:

• src/bp-members/bp-members-template.php (modified) (2 diffs)
• src/bp-members/classes/class-bp-members-component.php (modified) (2 diffs)
• tests/phpunit/testcases/routing/members.php (modified) (1 diff)

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

@@ -244 +244 @@
 
 /**
+ * Returns the registration page root slug.
+ *
+ * This function is used to set the BP Signup rewrite rule and permastruct.
+ *
+ * @since 15.0.0
+ *
+ * @return string The registration page root slug.
+ */
+function bp_get_signup_root_slug() {
+    /**
+     * Filter here to edit the registration page root slug.
+     *
+     * @since 15.0.0
+     *
+     * @param string $register_root_slug The registration page root slug.
+     */
+    return apply_filters( 'bp_members_register_root_slug', bp_get_signup_slug() );
+}
+
+/**
  * Output the activation slug.
  *
@@ -275 +295 @@
         return apply_filters( 'bp_get_activate_slug', $slug );
     }
+
+/**
+ * Returns the registration page root slug.
+ *
+ * This function is used to set the BP Signup rewrite rule and permastruct.
+ *
+ * @since 15.0.0
+ *
+ * @return string The registration page root slug.
+ */
+function bp_get_activate_root_slug() {
+    /**
+     * Filter here to edit the activation page root slug.
+     *
+     * @since 15.0.0
+     *
+     * @param string $activate_root_slug The activation page root slug.
+     */
+    return apply_filters( 'bp_members_activate_root_slug', bp_get_activate_slug() );
+}
 
 /**

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

@@ -228 +228 @@
 
         // Set-up Extra permastructs for the register and activate pages.
-        $this->register_permastruct = bp_get_signup_slug() . '/%' . $this->rewrite_ids['member_register'] . '%';
-        $this->activate_permastruct = bp_get_activate_slug() . '/%' . $this->rewrite_ids['member_activate'] . '%';
+        $this->register_permastruct = bp_get_signup_root_slug() . '/%' . $this->rewrite_ids['member_register'] . '%';
+        $this->activate_permastruct = bp_get_activate_root_slug() . '/%' . $this->rewrite_ids['member_activate'] . '%';
 
         // Init the User's ID to use to build the Nav for.
@@ -726 +726 @@
             ),
             'member_activate'     => array(
-                'regex' => bp_get_activate_slug() . '/?$',
+                'regex' => bp_get_activate_root_slug() . '/?$',
                 'order' => 40,
                 'query' => 'index.php?' . $this->rewrite_ids['member_activate'] . '=1',
             ),
             'member_activate_key' => array(
-                'regex' => bp_get_activate_slug() . '/([^/]+)/?$',
+                'regex' => bp_get_activate_root_slug() . '/([^/]+)/?$',
                 'order' => 30,
                 'query' => 'index.php?' . $this->rewrite_ids['member_activate'] . '=1&' . $this->rewrite_ids['member_activate_key'] . '=$matches[1]',
             ),
             'member_register'     => array(
-                'regex' => bp_get_signup_slug() . '/?$',
+                'regex' => bp_get_signup_root_slug() . '/?$',
                 'order' => 20,
                 'query' => 'index.php?' . $this->rewrite_ids['member_register'] . '=1',

trunk/tests/phpunit/testcases/routing/members.php

@@ -122 +122 @@
         $this->assertSame( get_current_user_id(), bp_displayed_user_id() );
     }
+
+    public function filter_root_slug( $root_slug ) {
+        return 'community/' . $root_slug;
+    }
+
+    /**
+     * @ticket BP9063
+     */
+    public function test_members_registration_page_filtered() {
+        $this->set_permalink_structure( '/%postname%/' );
+
+        add_filter( 'bp_members_register_root_slug', array( $this, 'filter_root_slug' ) );
+        bp_delete_rewrite_rules();
+
+        // Regenerate rewrite rules.
+        $this->go_to( home_url() );
+        $bp_registration_url = bp_get_signup_page();
+
+        remove_filter( 'bp_members_register_root_slug', array( $this, 'filter_root_slug' ) );
+
+        $this->go_to( $bp_registration_url );
+
+        $this->assertTrue( false !== strpos( $bp_registration_url, 'community' ) );
+        $this->assertTrue( bp_is_register_page() );
+    }
+
+    /**
+     * @ticket BP9063
+     */
+    public function test_members_registration_page() {
+        $this->set_permalink_structure( '/%postname%/' );
+        $bp_registration_url = bp_get_signup_page();
+
+        $this->go_to( $bp_registration_url );
+
+        $this->assertTrue( false === strpos( $bp_registration_url, 'community' ) );
+        $this->assertTrue( bp_is_register_page() );
+    }
+
+    /**
+     * @ticket BP9063
+     */
+    public function test_members_activation_page_filtered() {
+        $this->set_permalink_structure( '/%postname%/' );
+
+        add_filter( 'bp_members_activate_root_slug', array( $this, 'filter_root_slug' ) );
+        bp_delete_rewrite_rules();
+
+        // Regenerate rewrite rules.
+        $this->go_to( home_url() );
+        $bp_activation_url = bp_get_activation_page();
+
+        remove_filter( 'bp_members_activate_root_slug', array( $this, 'filter_root_slug' ) );
+
+        $this->go_to( $bp_activation_url );
+
+        $this->assertTrue( false !== strpos( $bp_activation_url, 'community' ) );
+        $this->assertTrue( bp_is_activation_page() );
+    }
+
+    /**
+     * @ticket BP9063
+     */
+    public function test_members_activation_page() {
+        $this->set_permalink_structure( '/%postname%/' );
+        $bp_activation_url = bp_get_activation_page();
+
+        $this->go_to( $bp_activation_url );
+
+        $this->assertTrue( false === strpos( $bp_activation_url, 'community' ) );
+        $this->assertTrue( bp_is_activation_page() );
+    }
 }