Components

BuddyPress chose a modular approach using components to organize its features. Two components are loaded by default (eg: BuddyPress Core and Community Members) while the majority are optionals. BuddyPress comes with 8 built-in optional components (Account Settings, Activity Streams, Extended Profiles, Friend connections, Notifications, Private messaging, User groups and Site Tracking).

Note: It’s important to note there can be more optional components regarding the BuddyPress plugins installed on the website : these plugins can use the BP Component API to incorpore the lists of active or inactive BuddyPress components.

Schema Schema

The schema defines all the fields that exist for BuddyPress components.

name
string
Name of the component.
Context: view, edit.
status
string
Whether the component is active or inactive.
Context: view, edit.
One of: active, inactive.
title
string
HTML title of the component.
Context: view, edit.
description
string
HTML description of the component.
Context: view, edit.

Top ↑

List the BuddyPress components List the BuddyPress components

Arguments Arguments

NameTypeDescription
contextstringScope under which the request is made; determines fields present in response.
Default: view
One of: view, edit.
pageintegerCurrent page of the collection.
Default: 1
per_pageintegerMaximum number of components to be returned in result set.
Default: 10
searchstringLimit results to those matching a string.
statusstringLimit result set to components with a specific status.
Default: all
One of: all, active, inactive
typestringLimit result set to components with a specific type.
Default: all
One of: all, optional, retired, required

Top ↑

Definition Definition

GET /buddypress/v1/components

Top ↑

Example of use Example of use

Alert: To use the bp.apiRequest function, you need to enqueue the bp-api-request JavaScript or use it as a dependency of your script. Refer to this page to know more about loading JavaScript files in WordPress.

bp.apiRequest( {
  path: 'buddypress/v1/components',
  type: 'GET',
  data: {
    context: 'view'
  }
} ).done( function( data ) {
  return data;
} ).fail( function( error ) {
  return error;
} );

Top ↑

Activate or Deactivate a BuddyPress component Activate or Deactivate a BuddyPress component

Top ↑

Arguments Arguments

NameTypeDescription
namestringName of the component.
Required.
actionstringWhether to activate or deactivate the component.
Required.
One of: activate, deactivate.

Top ↑

Definition Definition

PUT /buddypress/v1/components

Top ↑

Example of use Example of use

Alert: To use the bp.apiRequest function, you need to enqueue the bp-api-request JavaScript or use it as a dependency of your script. Refer to this page to know more about loading JavaScript files in WordPress.

bp.apiRequest( {
  path: 'buddypress/v1/components',
  type: 'PUT',
  data: {
    context: 'edit',
    name: 'activity',
    action: 'activate'
  }
} ).done( function( data ) {
  return data;
} ).fail( function( error ) {
  return error;
} );