<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][14011] trunk: Add 2 new filterable functions to get register/activate root slugs</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/14011">14011</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/14011","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-08-29 00:29:00 +0000 (Thu, 29 Aug 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="http://buddypress.trac.wordpress.org/ticket/9063">#9063</a>
Closes https://github.com/buddypress/buddypress/pull/364</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmembersbpmemberstemplatephp">trunk/src/bp-members/bp-members-template.php</a></li>
<li><a href="#trunksrcbpmembersclassesclassbpmemberscomponentphp">trunk/src/bp-members/classes/class-bp-members-component.php</a></li>
<li><a href="#trunktestsphpunittestcasesroutingmembersphp">trunk/tests/phpunit/testcases/routing/members.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmembersbpmemberstemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/bp-members-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/bp-members-template.php 2024-08-26 23:10:35 UTC (rev 14010)
+++ trunk/src/bp-members/bp-members-template.php 2024-08-29 00:29:00 UTC (rev 14011)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -243,6 +243,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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() );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Output the activation slug.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -276,6 +296,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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() );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Output the members invitation pane slug.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 8.0.0
</span></span></pre></div>
<a id="trunksrcbpmembersclassesclassbpmemberscomponentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/classes/class-bp-members-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/classes/class-bp-members-component.php 2024-08-26 23:10:35 UTC (rev 14010)
+++ trunk/src/bp-members/classes/class-bp-members-component.php 2024-08-29 00:29:00 UTC (rev 14011)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -227,8 +227,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $bp = buddypress();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Set-up Extra permastructs for the register and activate pages.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->register_permastruct = bp_get_signup_slug() . '/%' . $this->rewrite_ids['member_register'] . '%';
- $this->activate_permastruct = bp_get_activate_slug() . '/%' . $this->rewrite_ids['member_activate'] . '%';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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'] . '%';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Init the User's ID to use to build the Nav for.
</span><span class="cx" style="display: block; padding: 0 10px"> $user_id = bp_loggedin_user_id();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -725,17 +725,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'query' => 'index.php?' . $this->rewrite_ids['directory'] . '=1&' . $this->rewrite_ids['directory_type'] . '=$matches[1]',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'member_activate' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'regex' => bp_get_activate_slug() . '/?$',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'regex' => bp_get_activate_root_slug() . '/?$',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'order' => 40,
</span><span class="cx" style="display: block; padding: 0 10px"> 'query' => 'index.php?' . $this->rewrite_ids['member_activate'] . '=1',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'member_activate_key' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'regex' => bp_get_activate_slug() . '/([^/]+)/?$',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'regex' => bp_get_activate_root_slug() . '/([^/]+)/?$',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'order' => 30,
</span><span class="cx" style="display: block; padding: 0 10px"> 'query' => 'index.php?' . $this->rewrite_ids['member_activate'] . '=1&' . $this->rewrite_ids['member_activate_key'] . '=$matches[1]',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'member_register' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'regex' => bp_get_signup_slug() . '/?$',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'regex' => bp_get_signup_root_slug() . '/?$',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'order' => 20,
</span><span class="cx" style="display: block; padding: 0 10px"> 'query' => 'index.php?' . $this->rewrite_ids['member_register'] . '=1',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span></span></pre></div>
<a id="trunktestsphpunittestcasesroutingmembersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/routing/members.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/routing/members.php 2024-08-26 23:10:35 UTC (rev 14010)
+++ trunk/tests/phpunit/testcases/routing/members.php 2024-08-29 00:29:00 UTC (rev 14011)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -121,4 +121,76 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( get_current_user_id(), bp_displayed_user_id() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ 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() );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>