BuddyPress: Adding Custom Pages to Profiles

BuddyPress: Adding Custom Pages to Profiles

BuddyPress comes with all the profile and group pages it needs to access core settings and content. Sometimes you add a plugin to your site that’s not a BuddyPress plugin but you want to have a page on the profile to display this extra content. If you are a plugin developer, you can add support for BuddyPress using this same technique. Adding BuddyPress custom pages to profiles doesn’t have to be complicated!

Let’s say you have a portfolio plugin and you want to put a tab/page on a user profile and include the portfolio items. If your portfolio items are a custom post type then you can add a post loop on the page and pass in a query for the displayed BuddyPress user.

The following image is what we will accomplish in this tutorial:

profolio

Sometimes you add a plugin to your site that’s not a BuddyPress plugin, but you want to have a page on the profile to display this extra content.

Custom Profile Tab

Profile tabs are created by passing and array or arguments to bp_core_new_nav_item(). You can specify the name on the tab, the slug when you visit this page, the position in relation to the other tabs, css id and the callback function that runs when a user visits this URL. The position is the placement in the user navigation. Navigation items are positioned by incremented of ten. We pass fifty and that would be in the 5th position. If you wanted an item in between 5th and 6th, you can pass 51-59. The argument 'show_for_displayed_user'  is for a profile tab you only want a logged in user to see on their on profile.

  1. function bp_custom_user_nav_item() {
  2. global $bp;
  3.  
  4. $args = array(
  5. ‘name’ => __(‘Portfolio’, ‘buddypress’),
  6. ‘slug’ => ‘portfolio’,
  7. ‘default_subnav_slug’ => ‘portfolio’,
  8. ‘position’ => 50,
  9. ‘show_for_displayed_user’ => false,
  10. ‘screen_function’ => ‘bp_custom_user_nav_item_screen’,
  11. ‘item_css_id’ => ‘portfolio’
  12. );
  13.  
  14. bp_core_new_nav_item( $args );
  15. }
  16. add_action( ‘bp_setup_nav’, ‘bp_custom_user_nav_item’, 99 );

 

Screen Callback Function

Mentioned previously, you create a call back function that runs when a user visits the page. In this function you add an action to a function that does the rendering. Also, you can load a default template that contains the walls and ceiling of the profile page. This plugins.php file contains the member header and user navigation. It makes it super easy get a page up and then fill in the content area. If you were to load your own template file you’d lose the member header and user navigation. So, stick with plugins.php!

The 'default_subnav_slug' argument is to set which subnavigation item you want to land on when clicking the tab. You can choose to add subpages to a page, pass in 'parent_slug' argument and bp_core_new_nav_item() will make the page a subpage.

How does this actually work? You hook your render function to ‘bp_template_content’, in the plugins.php template that loads there is a do_action for 'bp_template_content' and then the render function shows your content.

  1. function bp_custom_user_nav_item_screen() {
  2. add_action( ‘bp_template_content’, ‘bp_custom_screen_content’ );
  3. bp_core_load_template( apply_filters( ‘bp_core_template_plugin’, ‘members/single/plugins’ ) );
  4. }

Screen Content Function

In the callback function there is an action 'bp_template_content'  that we hook our render function too. In this function is where you put the content you want to display.  This is a user profile so you will want to make the content pertain to the displayed user.

  1. function bp_custom_screen_content() {
  2.  
  3. echo ‘the custom content.
  4. You can put a post loop here,
  5. pass $user_id with bp_displayed_user_id()’;
  6.  
  7. }

BuddyPress internal APIs make it trivial to add custom pages. Check out this simple example plugin that includes the code above. If you have any issues comment below and I’ll try to help out.

Leave a Reply

Your email address will not be published. Required fields are marked *

Bitnami