Simple:Press Documentation

Plugin: Buddypress Integration

Plugin Description

Plugin: BuddyPress Integration (Buddypress) – This Simple:Press plugin extends the WordPress BuddyPress plugin to provide BuddyPress support for Profile Options, Forum Topics / Posts to the Activity Stream, Avatar selection, Forum links added to WP Admin Bar / BuddyBar, and Forum notifications added to WP Admin Bar.

Plugin Features

Note: The initial activation of the WordPress BuddyPress plugin:

  • Adds on the Admin menu for the site, an “Activity” top level entry as well as “BuddyPress” sub-menu entries for several existing top level entries.
    • Of particular interest on the Admin menu at Setting – BuddyPress – Settings, in the “Activity Settings” section associated with “Blog and Forum Comments” it is possible to select “Allow activity stream commenting on blog and forum posts”.
  • Adds on the site’s WP Admin Bar/BuddyBar, menu and submenu entries associated with the WordPress BuddyPress options the admin selected.

Installing this Simple:Press plugin adds:

  • A new “Buddypress” section in the Plugin Management panel under the Admin menu path Forum – Plugins – Available Plugins. From this panel the Simple:Press “Buddypress” plugin can be activated, or deleted by the admin.

Activating this plugin provides:

  • A change to the new “Buddypress” section in the Plugin Management panel under the Admin menu path Forum – Plugins – Available Plugins so the Simple:Press “Buddypress” plugin can be deactivated, uninstalled, and have it Options set.
  • A new “Buddypress Plugin” admin screen with radio buttons where profile options, activity stream options, Avatar options, WP Admin Bar / BuddyBar Forum Link options, and WP Admin Bar Notifications can be set up.
  • A new “Buddypress” sub-menu entry under the Admin menu Forum – Components that links to the aforementioned “Buddypress Plugin” admin screen for setting up options.

Selections made using this Simple:Press plugin can add:

  • Simple:Press forum information to the WP Admin Bar at the top of each web page.
  • Simple:Press forum information to the various WordPress BuddyPress menus and screens.

There are no new permissions added to the permission sets due to this plugin.

Plugin Requirements

The WordPress BuddyPress plugin is required and must first be downloaded, installed, activated, and set up. Please see WordPress page BuddyPress for WordPress for more information.

  • WordPress BuddyPress requires that the default permalink structure NOT be used.
  • Watch for the message, “BuddyPress is almost ready. You must update your permalink structure to something other than the default for it to work.”
  • Make the necessary permalink change if this message is displayed.

Simple:Press version 5.5.6 and above is required.

The Simple:Press plugin must be installed, activated, and its options set before it is operational.

As part of the installation, a “Buddypress” section is added to the Plugin Management panel under the admin menu Forum – Plugins – Available Plugins. From this panel the Buddypress plugin can be activated, deactivated, uninstalled, deleted, or its options set up using its “Activate/Delete” and “Deactivate/Uninstall/Options” selections.

The plugin does not have template tags incorporated into current themes so developing a Custom or Child Theme to accommodate any desired template tag changes is not needed before installing this plugin. Information on installing themes is located on our Creating a Custom Theme page.

Plugin Installation and Activation

Please see Using Plugins on how to obtain and install the Simple:Press BuddyPress Integration (Buddypress) plugin.

As mentioned there, the default location for Simple:Press plugin folders is …/wp-content/sp-resources/forum-plugins. If this path is changed, it is important to note that the plugin’s folder and its content need to reside in the forum plugins folder wherever it has been moved and however it has been renamed. See Storage Locations for more information.

Activation is accomplished from the Admin Dashboard panel menu by selecting “Forum” and then “Plugins” from the drop down Forum Admin menu. On the Simple:Press Administration panel select the “Buddypress” plugin on the “Plugin Management” panel and click on “Activate”. The “Activate/Delete” label changes to “Deactivate/Uninstall/Options”. To deactivate the plugin, click on “Deactivate”. The “Deactivate/Uninstall/Options” label changes to “Activate/Delete”.

Plugin Administrative Options

After activation, a) on the aforementioned “Available Plugins” page and “Plugin Management” panel, click “Options” on the “Buddypress” plugin section or b) under the “Components” entry on the forum menu on the left side forum admin page click the “BuddyPress” submenu item to get the BuddyPress Plugin panel with “Profile Options”, “Activity Stream”, “Avatars”, “WP Admin Bar / BuddyBar Forum Links”, and “WP Admin Bar Notifications” sections.

  • Selecting “Profile Options”
    • In this section, one can choose some general BuddyPress / Simple:Press profile options. If one wants to integrate the forum profile and the BuddyPress profiles, select the integration option. Please note, this will NOT move all the various forum profile tabs over to BuddyPress. It will duplicate the key options and items on the BuddyPress profile. One should consider whether or not to disable the link to the forum profile with this option enabled. One can also elect to have the manage topic and forum subscriptions and manage watches profile menus show up in the Buddypress profile.
    • In the “Profile Options” section, click on the radio button to the left of option to select the option. The radio button indicates it is selected by turning green in color. Deselect an option by clicking a green colored radio button. The radio button indicates it is deselected by turning gray in color.
    • The selections are:
      • Integrate key forum profile elements on BuddyPress profile
      • Integrate subscription management on BuddyPress profile
      • Integrate watches management on BuddyPress profile
    • Click on the “Update” button to save the setting if no other changes are to be made in the other sections of the panel. Otherwise, wait to click the “Update” button until all desired changes have been made.
  • Selecting “Activity Stream” Options
    • In this section, one can choose how to have forum activity reflected in the BuddyPress activity streams. One can choose to not have any forum activity show up, choose to have only new topics show up, or choose to have both new topics and replies show up. Only posts added since the activity was enabled will show up in the activity feed.
    • In the “Activity Stream” section, click on the radio button to the left of an option to select the option. The radio button indicates it is selected by turning green in color. Deselect an option by clicking a green colored radio button. The radio button indicates it is deselected by turning gray in color.
    • “Add BuddyPress activity for” selections are:
      • Do not add activity for forum posts
      • New Forum topics only
      • All forum posts
    • Click on the “Update” button to save the setting if no other changes are to be made in the other sections of the panel. Otherwise, wait to click the “Update” button until all desired changes have been made.
  • Selecting “Avatars” Options
    • In this section, one can choose how to have BuddyPress and Simple Press share avatars. One can elect to keep the avatars completely separate and have each plugin continue using their own avatars. Or one can choose to have a common avatar, selecting to use either the BP or SP avatar for both. If choosing to use the Buddypress avatar in the forum, one can also select whether to use the BuddyPress thumbnail avatar or the full size avatar. The image quality is the same, just the file size is different with the full size avatar taking more time to display. The BuddyPress thumbnail avatar is 50px by 50px. If displaying forum avatars at a size of 50px or less, it is recommended that the thumbnail avatar size be used. If displaying the forum avatars at more than 50px, it is recommended that the full size avatar be used since the smaller one won’t scale up very well.
    • In the “Avatars” section, click on the radio button to the left of an option to select the option. The radio button indicates it is selected by turning green in color. Deselect an option by clicking a green colored radio button. The radio button indicates it is deselected by turning gray in color.
    • “BuddyPress/Simple:Press avatar handling” selections are:
      • Keep avatars separate
      • Use BuddyPress avatars for both
      • Use Simple:Press avatars for both
      • Use BuddyPress full size avatar
    • Click on the “Update” button to save the setting if no other changes are to be made in the other sections of the panel. Otherwise, wait to click the “Update” button until all desired changes have been made.
  • Selecting “WP Admin Bar/BuddyBar Forum Links” Options
    • In this section, one can choose which forum links to add to the WP Admin Bar BuddyPress section and to the BuddyBar. The options shown will depend on which SP plugins are activated. Possible links are: to main site, SP profile, new forum posts, new PMs, new subscribed topics, new watched topics, topics started, and topics posted in.
    • In the “WP Admin Bar/BuddyBar Forum Links” section, click on the radio button to the left of option to select the option. The radio button indicates it is selected by turning green in color. Deselect an option by clicking a green colored radio button. The radio button indicates it is deselected by turning gray in color.
    • The possible selections are:
      • Show forum links in the BuddyPress bars
        • Selecting this option adds a “Forum” sub-menu item to the WP Admin Bar for viewing the items immediately below that may be selected. The selected items will have sub-menu entries under “Forum” that are links to the information.
      • Add forum new posts link
      • Add forum PM inbox link
      • Add forum subscriptions link
      • Add forum watches link
      • Add forum profile link
      • Add link to topics started
      • Add link to topics posted in
    • Click on the “Update” button to save the setting if no other changes are to be made in the other sections of the panel. Otherwise, wait to click the “Update” button until all desired changes have been made.
  • Selecting “WP Admin Bar Notifications” Options
    • In this section, one can choose which forum notifications to add to the WP Admin Bar BuddyPress notifications section. The options shown will depend on which SP plugins are activated. Possible notifications are: new forum posts, new PMs, new subscribed topics, and new watched topics.
    • In the “WP Admin Bar Notifications” section, click on the radio button to the left of option to select the option. The radio button indicates it is selected by turning green in color. Deselect an option by clicking a green colored radio button. The radio button indicates it is deselected by turning gray in color.
    • The possible selections are:
      • Show forum notifications in the BuddyPress bars
        • Selecting this option results in the WP Admin Bar notification counter being incremented when there are notifications for the selected items listed immediately below. Hovering the cursor over the notification counter results in a list of the types and numbers of forum related unread notifications. Each list item is a link to that type of unread notification.
      • Add forum new posts notifications
      • Add forum new PM notifications
      • Add forum subscriptions notifications
      • Add forum watches notifications
    • Click on the “Update” button to save the setting if no other changes are to be made in the other sections of the panel. Otherwise, wait to click the “Update” button until all desired changes have been made.

There are no new permissions associated with this Simple:Press plugin that need to be set.

Plugin Language Translation

A plugin’s message strings can be translated from English to other languages and then the translation displayed if language translation files are available. Some plugins may not have such files.

Information regarding downloading language files, “mo’ language file placement, and translation (language localization) is found at Localization.

More information is available regarding translation files at Simple:Press Translations. On the base page, select the “Getting Started Guide” link for basics about it’s use. On that page, select the “register a username here” link to obtain a password to the site. Use the “Contact Form” link to request the desired language if it is not currently available. The “Contact Form” link may also be used to volunteer to be a validator for a translation project.

The Buddypress Integration (Buddypress) plugin’s available language translation files with translation statistics, and message translations can be viewed at Buddypress Integration (Buddypress) Translations. Select the Version link to see the languages available. Select the link for the desired language to see forum messages and their available translations. If available, export the file for the selected language to its proper forum language sub-folder as a “mo” file using the export link at the bottom of the page displaying the actual message translations for the language selected.

The default location for Simple:Press plugin language files is …/wp-content/sp-resources/forum-language/sp-plugins. If this path is changed, it is important to note that the plugin’s language file needs to reside in the language sub-folder for sp plugins wherever it has been moved and however it has been renamed. See Storage Locations for more information.

Plugin Usage

Forum users, please see the WordPress page BuddyPress for WordPress for any available information on viewing BuddyPress information such as links, notifications, etc. available on the WP Admin bar at the top of each web page  or any other WordPress BuddyPress information available on the website pages /screens.

  • Selections made by the admin for Simple:Press information to be displayed with WordPress BuddyPress will show up on the WP Admin bar and/or these screens.

Admins, please see the WordPress page BuddyPress for WordPress for any available information on initial set up of the WordPress BuddyPress plugin, using the new Admin menu entry “Activity”, the “BuddyPress” sub-menu additions to “Plugins”, “Setting”, and “Tools”, as well as the links, notifications, etc. available on the WP Admin bar at the top of each web page. Please use this same link for any other WordPress BuddyPress information available on the website pages / screens.

  • Selections made by the admin for Simple:Press information to be display with WordPress BuddyPress will show up on the WP Admin bar and/or these screens.

Plugin Special Notes

This Simple:Press plugin requires that the WordPress “BuddyPress” plugin is installed, activated, and set up first.

Template Tags Used in the Plugin

There are no Template Tags available for this plugin that allows the admin to further customize it’s usage or otherwise customize the website.

Actions and Hooks Used in the Plugin

There are no Actions and Hooks available in Template Tags for this plugin.

There are other Actions and Hooks available for this plugin.

Used in file sp-buddypress-activity.php.

  • apply_filters(‘sph_buddypress_new_activity’, true, $newpost)- Allows for users to optionally stop posting of a post to the Buddypress activity stream. Useful if you want to stop the activity posting for specific users, forums, topics or whatever. It provdes a mechanism for individually overriding the activity stream posting.

Used in file sp-buddypress-screens.php

  • apply_filters(‘sph_buddypress_updated_forum_profile’, $errors, bp_displayed_user_id()) – Allows other plugins to interact with sharing of data to the Buddypress profile. If the update resulted in errors, an error message is shown.  Otherwise, “Forum profile changes saved” will be displayed.
  • apply_filters(‘sph_ProfileUserTimezone’, $tout, $spProfileUser->ID) – Allows overriding of the user’s timezone option selection into the BuddyPress profile screen. $tout will contain the html display code.
  • apply_filters(‘sph_ProfileUserSyncName’, $tout, $spProfileUser->ID) – Allows overriding of syncing of the user’s name between the forum and BuddyPress into the BuddyPress profile screen. $tout will contain the html display code.
  • apply_filters(‘sph_ProfileUserOnlineStatus’, $tout, $spProfileUser->ID) – Allows overriding of the user’s online status (hidden or visible) into the BuddyPress profile screen. $tout will contain the html display code.
  • apply_filters(‘sph_ProfileUserUnread’, $tout, $spProfileUser->ID) – Allows overriding of the number of the user’s unread posts into the BuddyPress profile screen. $tout will contain the html display code.
  • apply_filters(‘sph_ProfilePostingOptionsFormEditors’, $tout, $spProfileUser) – Allows overriding of the preferred editor option into the BuddyPress profile screen. $tout will contain the html display code.
  • apply_filters(‘sph_ProfileUserEditor’, $tout, $spProfileUser->ID) – Allows overriding of the user’s editor selection into the BuddyPress profile screen. $tout will contain the html display code.
  • apply_filters(‘sph_ProfileSignatureForm’, $tout, $spProfileUser->ID) – Allows overriding of the user’s signature into the Buddypress profile screen. $tout will contain the html display code.
  • apply_filters(‘sph_ProfileUserSubsAutoSub’, $tout, $spProfileUser->ID) – If the Simple:Press Subscriptions plugin is active, allows overriding of the user’s subscription options into the Buddypress profile screen. $tout will contain the html display code.
  • apply_filters(‘sph_ProfileUserSubsAutoStart’, $tout, $spProfileUser->ID) – If the Simple:Press Subscriptions plugin is active, allows overriding of the user’s “Auto subscribe to topic I start:” subscription option into the Buddypress profile screen. $tout will contain the html display code.
  • apply_filters(‘sph_ProfileUserSubsDigest’, $tout, $spProfileUser->ID) – If the Simple:Press Subscriptions plugin is active, allows overriding of the user’s “Receive subscription notifications in digest form” subscription option into the Buddypress profile screen. $tout will contain the html display code.
  • apply_filters(‘sph_ProfileUserMentionsOptOut’, $tout, $spProfileUser->ID) – If the Simple:Press Mentions plugin is active, allows overriding of the user’s “Opt out of receiving forum mentions notifications” option into the Buddypress profile screen. $tout will contain the html display code.
  • apply_filters(‘sph_ProfileUserPMEmail’, $tout, $spProfileUser->ID) – If the Simple:Press Private Messaging plugin is active, allows overriding of the user’s “Receive an email when someone sends you a forum private message” option into the Buddypress profile screen. $tout will contain the html display code.
  • apply_filters(‘sph_ProfileUserPMOptOut’, $tout, $spProfileUser->ID) – If the Simple:Press Private Messaging plugin is active, allows overriding of the user’s “Opt out of forum private messaging” option into the Buddypress profile screen. $tout will contain the html display code.
  • apply_filters(‘sph_buddypress_updated_topic_subs’, $errors, bp_displayed_user_id()) – Allows other plugins to interact with the subscribed topics in the Buddypress profile. If the update resulted in errors, an error message is shown.  Otherwise, “Topic subscriptions updated” will be displayed.
  • apply_filters(‘sph_buddypress_updated_forum_subs’, $errors, bp_displayed_user_id()) – Allows other plugins to interact with the forum subscriptions in the Buddypress profile. If the update resulted in errors, an error message is shown.  Otherwise, “Forum subscriptions updated” will be displayed.
  • apply_filters(‘sph_buddypress_updated_watches’, $errors, bp_displayed_user_id()) – Allows other plugins to interact with the watches in the Buddypress profile. If the update resulted in errors, an error message is shown.  Otherwise, “Watches updated” will be displayed.
  • do_action(‘sph_buddypress_forum_profile_before’) – Hook fired before the BuddyPress forum profile information is displayed.
  • do_action(‘sph_buddypress_forum_profile_after’) – Hook fired after the BuddyPress forum profile information is displayed.
  • do_action(‘sph_buddypress_topic_subs_before’) – Hook fired before the BuddyPress topic subscriptions information is displayed.
  • do_action(‘sph_buddypress_topic_subs_after’) – Hook fired after the BuddyPress topic subscriptions information is displayed.
  • do_action(‘sph_buddypress_forum_subs_before’) – Hook fired before the BuddyPress forum subscriptions information is displayed.
  • do_action(‘sph_buddypress_forum_subs_after’) – Hook fired after the BuddyPress forum subscriptions information is displayed.
  • do_action(‘sph_buddypress_watches_before’) – Hook fired before the BuddyPress watches information is displayed.
  • do_action(‘sph_buddypress_watches_after’) – Hook fired after the BuddyPress watches information is displayed.

Used in file sp-buddypress-plugin.php

  • do_action(‘bp_math_check_errors’) – Hook fired to check for math errors associated with Buddypress registration.
  • do_action(‘bp_captcha_check_errors’) – Hook fired to check for captcha errors associated with Buddypress registration.

Plugin and Template Tag Changelog

Since Simple:Press version 5.5.0.

Codex page sync’d to code version 5.5.3.

More Topics In SimplePress: Plugins


Copyright © 2006-2019 Simple:Press. All Rights Reserved.