<!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][14012] trunk/docs/user: Documentation: explain how to customize BP base URL</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/14012">14012</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/14012","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-30 02:26:45 +0000 (Fri, 30 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'>Documentation: explain how to customize BP base URL
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/9063">#9063</a>
Closes https://github.com/buddypress/buddypress/pull/367</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkdocsuseradvancedREADMEmd">trunk/docs/user/advanced/README.md</a></li>
<li><a href="#trunkdocsusermanifestjson">trunk/docs/user/manifest.json</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkdocsuseradvancedcustombaseurlmd">trunk/docs/user/advanced/custom-base-url.md</a></li>
<li><a href="#trunkdocsuserassetsadvancedcustomrootslugupdatenavigationblockpng">trunk/docs/user/assets/advanced-custom-root-slug-update-navigation-block.png</a></li>
<li><a href="#trunkdocsuserassetsadvancedcustomrootslugupdatepermalinkspng">trunk/docs/user/assets/advanced-custom-root-slug-update-permalinks.png</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkdocsuseradvancedREADMEmd"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/docs/user/advanced/README.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/user/advanced/README.md 2024-08-29 00:29:00 UTC (rev 14011)
+++ trunk/docs/user/advanced/README.md 2024-08-30 02:26:45 UTC (rev 14012)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3,3 +3,4 @@
</span><span class="cx" style="display: block; padding: 0 10px"> - Customizing templates
</span><span class="cx" style="display: block; padding: 0 10px"> - [Customizing functionalities](functionalities.md)
</span><span class="cx" style="display: block; padding: 0 10px"> - [Customizing texts](texts.md)
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+- [Customizing BP Base URL](custom-base-url.md)
</ins></span></pre></div>
<a id="trunkdocsuseradvancedcustombaseurlmd"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/advanced/custom-base-url.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/user/advanced/custom-base-url.md (rev 0)
+++ trunk/docs/user/advanced/custom-base-url.md 2024-08-30 02:26:45 UTC (rev 14012)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,70 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+# Customizing BuddyPress base URL
+
+Adding BuddyPress directories as a submenu of a regular WordPress page (for example: a page titled "Community") is pretty easy, you simply need to use the right [Administration screen of your dashboard](../administration/navigations/README.md) (`Appearance > Menus` or `Appearance / Site editor`).
+
+It requires a bit more work when you need the "Community" page URL to be used as the BuddyPress base URL (eg: `https://site.url/community/members/`). Below are the 3 steps you need to accomplish to make it happen.
+
+## 1. Use filters to customize the BuddyPress base URL
+
+You can use the [bp-custom.php](functionalities.md) file to prepend an URL chunk to BuddyPress base URLs for all BP directories & BP specific pages.
+
+The filter names to use are:
+
+- `'bp_activity_root_slug'` - The Activity directory page,
+- `'bp_members_root_slug'` - The Members directory page,
+- `'bp_members_register_root_slug'` - The BP registration page,
+- `'bp_members_activate_root_slug'` - The BP activation page,
+- `'bp_groups_root_slug'` - The Groups directory page,
+- `'bp_blogs_root_slug'` - The Sites directory page (for multisite configurations),
+
+```php
+<?php
+/**
+ * Here resides my awesome BuddyPress functionality customizations!
+ *
+ * Using this file is making sure the custom code is loaded when
+ * BuddyPress is activated and ready to power the community area
+ * of my WordPress site.
+ */
+
+// Exit if accessed directly.
+if ( ! defined( 'ABSPATH' ) ) {
+ exit;
+}
+
+/**
+ * Prepends a 'community' URI chunk to BP directory root slugs.
+ *
+ * @param string $root_slug The BP Default root slug.
+ * @return string The new root slug having the 'community' URI chunk prepended.
+ */
+function prepend_community_slug( $root_slug ) {
+ return 'community/' . $root_slug;
+}
+add_filter( 'bp_activity_root_slug', 'prepend_community_slug' );
+add_filter( 'bp_members_root_slug', 'prepend_community_slug' );
+add_filter( 'bp_members_register_root_slug', 'prepend_community_slug' );
+add_filter( 'bp_members_activate_root_slug', 'prepend_community_slug' );
+add_filter( 'bp_groups_root_slug', 'prepend_community_slug' );
+```
+
+## 2. Update your site permalinks
+
+Once the above custom code is in place, you need to update your site permalinks from the `Settings > Permalinks` Administration screen so that BuddyPress rewrite rules are updated and the customization is actually taken in account.
+
+
+
+Simply click on the "Save Changes" blue button to refresh your permalink settings.
+
+## 3. Update your site's navigation
+
+Go to the Administration screen you use to customize your site's main navigation:
+
+- The [WordPress Appearance Menus screen](../administration/navigations/README.md#appearance-menus-screen) if you are using a **regular theme** and a WordPress Nav Menu.
+- The [WordPress Appearance Site Editor](../administration/navigations/README.md#site-editor-navigation) if you are using a **block theme** and the Navigation block.
+
+
+
+First make sure to remove existing BuddyPress directory menu items as their URLs are not using the `community` prepended URL chunk you added thanks to your customization yet.
+
+Once done, as shown in the above screenshot, you just need to Add the "Community" page to you site's navigation and add a Sub Menu to this page containing your BuddyPress directories.
</ins></span></pre></div>
<a id="trunkdocsuserassetsadvancedcustomrootslugupdatenavigationblockpng"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/assets/advanced-custom-root-slug-update-navigation-block.png</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<span class="cx" style="display: block; padding: 0 10px">Index: trunk/docs/user/assets/advanced-custom-root-slug-update-navigation-block.png
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- trunk/docs/user/assets/advanced-custom-root-slug-update-navigation-block.png 2024-08-29 00:29:00 UTC (rev 14011)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ trunk/docs/user/assets/advanced-custom-root-slug-update-navigation-block.png 2024-08-30 02:26:45 UTC (rev 14012)
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/docs/user/assets/advanced-custom-root-slug-update-navigation-block.png
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span><a id="svnmimetype"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:mime-type</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+image/png
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunkdocsuserassetsadvancedcustomrootslugupdatepermalinkspng"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/assets/advanced-custom-root-slug-update-permalinks.png</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<span class="cx" style="display: block; padding: 0 10px">Index: trunk/docs/user/assets/advanced-custom-root-slug-update-permalinks.png
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- trunk/docs/user/assets/advanced-custom-root-slug-update-permalinks.png 2024-08-29 00:29:00 UTC (rev 14011)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ trunk/docs/user/assets/advanced-custom-root-slug-update-permalinks.png 2024-08-30 02:26:45 UTC (rev 14012)
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/docs/user/assets/advanced-custom-root-slug-update-permalinks.png
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span><a id="svnmimetype"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:mime-type</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+image/png
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunkdocsusermanifestjson"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/docs/user/manifest.json</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/user/manifest.json 2024-08-29 00:29:00 UTC (rev 14011)
+++ trunk/docs/user/manifest.json 2024-08-30 02:26:45 UTC (rev 14012)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -168,6 +168,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "parent": null
</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">+ "title": "Customizing BuddyPress base URL",
+ "slug": "advanced-custom-base-url",
+ "markdown_source": "../user/advanced/custom-base-url.md",
+ "parent": null
+ },
+ {
</ins><span class="cx" style="display: block; padding: 0 10px"> "title": "BuddyPress Components",
</span><span class="cx" style="display: block; padding: 0 10px"> "slug": "components",
</span><span class="cx" style="display: block; padding: 0 10px"> "markdown_source": "../user/components/README.md",
</span></span></pre>
</div>
</div>
</body>
</html>