Skip to:
Content

BuddyPress.org

Changeset 13719


Ignore:
Timestamp:
01/30/2024 05:38:27 AM (18 months ago)
Author:
imath
Message:

docs/user: update the URLs settings screen documentation

  • Update screenshots to latest BP version
  • Explain how to use each panel of the accordion UI

Closes ​https://github.com/buddypress/buddypress/pull/224

Location:
trunk/docs/user
Files:
4 added
1 deleted
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/docs/user/administration/settings/urls.md

    r13501 r13719  
    11# BuddyPress URLs settings
    22
    3 Since version 12.0 of BuddyPress, you can now customize all URLs the plugin is generating to display your community content. An important change to note: BuddyPress directory pages are no longer regular WordPress pages and customizing these directory titles or URLs as well as any other BP URLs is only possible from the URLs tab of the BuddyPress settings Administration screen.
     3Since version 12.0, BuddyPress no longer uses regular WordPress pages to let site administrators customize BP Directories titles and permalinks.
    44
    5 ![BP URLs tab screenshot](../../assets/bp-settings-customize-slugs.png)
     5BuddyPress is now automatically generating specific entries into your WordPress site's database to store the information needed by BP Components requiring a directory to list their single items (eg: the Members directory is the community members).
     6
     7Benefits are:
     8
     9- It's no more needed to manually perform WordPress page association.
     10- Community content is not mixed with your regular WordPress content.
     11- BuddyPress URLs customization has been extended to **every chunks** of **any** URLs generated by the plugin to display your community content.
     12- BuddyPress supports any permalink structures, even the plain one!
     13- You can set all BP Components titles & URLs information from one screen: the URLs tab of the BuddyPress settings.
     14
     15![BP URLs tab screenshot](../../assets/bp-admin-settings-urls-screen-001.png)
     16
     17## The BP Component's directory panel
     18
     19Every BP Component using a directory gets an accordion panel to let you customize its title and permalink as well as potential single item screen URLs when supported (eg: Members and Groups). Open the component's panel you need to edit the title or URL for and use the form fields to set your preferences.
     20
     21![BP URLs directory panel screenshot](../../assets/bp-admin-settings-urls-screen-002.png)
     22
     23You can use the "View" link to reach your directory page. Once you edited your directory slug, you'll need to save your changes from the "Save Settings" blue button at the bottom of the page to update your directory permalink.
     24
     25> [!NOTE]
     26> If you need to add a link to your directory into your WordPress navigation, this [documentation page](./../navigations/README.md) is explaining how to achieve this in regular or Block Themes.
     27
     28## The BP Component's single item primary & secondary screens panels
     29
     30These panels are only available for the Groups and the Members components. To build a group or a member URL, BuddyPress simply adds the single item name (formatted to be used into an URL) at the end of the directory permalink. For single item primary screens, it adds the primary slug to the Group or Member URL and so on.
     31
     32This panel is the place where you'll be able to edit every URL chunk (or slug) that will be added after the single item URL.
     33
     34![BP URLs primary/secondary screens panel screenshot](../../assets/bp-admin-settings-urls-screen-003.png)
     35
     36## Specific BP pages panels
     37
     38If registrations to your community site are allowed, BuddyPress is overriding the WordPress registration process so that it can happen on the front-end of your site (instead of the WordPress login screen). The BP registration process has a 2 steps: the member submits a registration form from the corresponding page, then once they received the activation email, they use the activation link to reach the activation page.
     39
     40> [!IMPORTANT]
     41> Unlike directory permalinks, there's no "View" link for these specific pages as you need to log out to reach these.
     42
     43![BP URLs register/activate panels screenshot](../../assets/bp-admin-settings-urls-screen-004.png)
     44
     45> [!NOTE]
     46> Once you're satisfied with URLs customization, don't forget to click on the "Save Settings" blue button at the bottom of the page to save your BuddyPress URLs settings.
Note: See TracChangeset for help on using the changeset viewer.