User Blogs
Topics
The Site Tracking components comes, on WordPress Multisite configurations, with a directory page listing all public user Blogs of your network of sites. Thanks to the BP Blogs REST Endpoint, you can fetch these public blogs into your Application.
Schema
The schema defines all the fields that exist for a Blog object.
idinteger | Unique identifier for the Blog. Read only Context: view, edit |
user_idinteger | A unique numeric ID for the Blog’s administrator. Read only Context: view, edit |
namestring | The Blog’s name. Read only Context: view, edit |
permalinkstring, uri | The Blog’s permalink. Read only Context: view, edit |
descriptionstring | The Blog’s description. Read only Context: view, edit |
pathstring | The Blog’s relative path to the network’s domain (when Multisite is using sub-directories for blogs) Read only Context: view, edit |
domainstring | The Blog’s domain (or the network’s domain when Multisite is using sub-directories for blogs). Read only Context: view, edit |
last_activitystring or null | The last activity date from the Blog, in the network’s timezone. Read only Context: view, edit |
last_activity_gmtstring or null | The last activity date from the Blog, as GMT. Read only Context: view, edit |
avatar_urls (1)object | Avatar URLs for the Blog (Full & Thumb sizes). It uses the WordPress site icon feature if supported, and falls back on the Administrator’s avatars. Read only Context: view, edit |
(1) Only if the WordPress discussion settings allow avatars.
List Blogs
Arguments
| Name | Type | Description |
|---|---|---|
| context | string | Scope under which the request is made; determines fields present in response. Default: viewOne of: view, edit |
| page | integer | Current page of the collection. Default: 1 |
| per_page | integer | Maximum number of members to be returned in result set. Default: 10 |
| search | string | Limit results to site titles, domains, descriptions matching the searched terms. |
| user_id | integer | The unique numeric identifier of the user having publishing capabilities on the Blog. |
| include | array | Ensure result set include specific Blog IDs. Default: [] |
| type | string | Shorthand for certain orderby/order combinations. Default: activeOne of: active, newest, alphabetical, random |
Definition
GET /buddypress/v1/blogs
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/blogs',
type: 'GET',
data: {
context: 'view'
}
} ).done( function( data ) {
return data;
} ).fail( function( error ) {
return error;
} );
Create a Blog
Note: This route requires the Blogs signup option to be active into the WordPress Network Administration settings.
Arguments
| Name | Type | Description |
|---|---|---|
| name | string | The new site’s name (used for the site URL). Required |
| title | string | The new site’s title. Required |
| site_id | integer | The new site’s network ID. (Only relevant on multi-network installations). Default: 1 |
| user_id | integer | The user ID of the new site’s admin. Default: the logged in user ID. |
| meta | array | Set initial Blog options. Default: [] |
Definition
POST /buddypress/v1/blogs
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/blogs',
type: 'POST',
data: {
context: 'edit',
name: 'buddypress',
title: 'BuddyPress',
}
} ).done( function( data ) {
return data;
} ).fail( function( error ) {
return error;
} );
Retrieve a specific Blog
Arguments
| Name | Type | Description |
|---|---|---|
| id | integer | Unique identifier for the Blog. |
| context | string | Scope under which the request is made; determines fields present in response. Default: viewOne of: view, edit |
Definition
GET /buddypress/v1/blogs/<id>
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/blogs/2',
type: 'GET',
data: {
context: 'view'
}
} ).done( function( data ) {
return data;
} ).fail( function( error ) {
return error;
} );