User Signups
Topics
The BuddyPress Signups endpoint helps you manage member registrations of your community site.
Schema
The schema defines all the fields that exist for a signup object.
idinteger | Unique numeric identifier for the signup. Read only Context: view, edit |
user_loginstring | The login of the new user. Required Context: view, edit |
user_name (1)string | The full name of the new user. Required Context: view, edit |
user_emailstring | The email of the new member. Required Context: edit |
activation_keystring | The signup’s activation key. Read only Context: edit |
registeredstring or null | The registration date for the new member, in the site’s timezone. Read only Context: view, edit |
registered_gmtstring or null | The registration date for the new member, as GMT. Read only Context: view, edit |
date_sentstring or null | The date the activation email was sent to the pending member, in the site’s timezone. Read only Context: edit |
date_sent_gmtstring or null | The date the activation email was sent to the pending member, as GMT. Read only Context: edit |
count_sentinteger | The number of times the activation email was sent to the pending member. Read only Context: edit |
metaobject | The signup meta information. BuddyPress uses it to store the password hash of the new member. This password hash is never included into the BP REST API responses. Context: edit |
site_name (2)string | Unique name (slug) of the new member’s child site. Default: ''Context: edit |
site_title (2)string | Title of the new member’s child site. Default: ''Context: edit |
site_public (2)boolean | Search engine visibility of the new member’s site. true to be visible, false otherwise.Default: trueContext: edit |
site_language (2)string | Language to use for the new member’s site. Default: the Network main site’s locale (eg: en_US)One of: the available locales of the Network. Context: edit |
(1) Only available if the BuddyPress xProfile component is active.
(2) Only available on WordPress Multisite configurations where it is possible to signup with a blog.
List Signups
Arguments
| Name | Type | Description |
|---|---|---|
| context | string | Scope under which the request is made; determines fields present in response. Default: viewOne of: view, edit |
| number | integer | Total number of signups to return. Default: 1 |
| offset | integer | Offset the result set by a specific number of items. Default: 1 |
| include | array | Ensure the result set includes specific Signup IDs. Default: [] |
| user_login | string | Ensure the result set only returns the signup for a specific pending member login. Default: '' |
| orderby | string | Order the result set according to a specific parameter. Default: signup_idOne of: signup_id, login, email, registered, activated |
| order | array | Order sort type (ascending or descending). Default: descOne of: asc, desc |
Definition
GET /buddypress/v1/signup
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/signup',
type: 'GET',
data: {
context: 'view'
}
} ).done( function( data ) {
return data;
} ).fail( function( error ) {
return error;
} );
Signup a user (with or without a blog)
Arguments
| Name | Type | Description |
|---|---|---|
| user_login | string | A numeric identifier for the new member. Required |
| password | string | Password for the new member. Required |
| user_email | string | The email address for the new member. Required |
| user_name (1) | string | Full name for the new member. Required |
| site_name (2) | string | Unique name (slug) of the new member’s child site. Default: '' |
| site_title (2) | string | Title of the new member’s child site. Default: '' |
| site_public (2) | boolean | Search engine visibility of the new member’s site. true to be visible, false otherwise.Default: true |
| site_language (2) | string | Language to use for the new member’s site. Default: the Network main site’s locale (eg: en_US) |
(1) Only available if the BuddyPress xProfile component is active.
(2) Only available on WordPress Multisite configurations where it is possible to signup with a blog.
Definition
POST /buddypress/v1/signup
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.
// Example for a simple signup when the BP xProfile component is not active.
bp.apiRequest( {
path: 'buddypress/v1/signup',
type: 'POST',
data: {
context: 'edit',
user_login: 'testuser',
user_email: 'test@user.mail',
password: 'password' // Always use strong passwords, not like this one!
}
} ).done( function( data ) {
return data;
} ).fail( function( error ) {
return error;
} );
Retrieve a specific Signup
Arguments
| Name | Type | Description |
|---|---|---|
| id | string | Unique identifier for the signup. It can be a signup ID, an email address, or most likely an activation key. Required |
| context | string | Scope under which the request is made; determines fields present in response. Default: viewOne of: view, edit |
Definition
GET /buddypress/v1/signup/<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/signup/1f56ce56bf66ef53', // Activation key.
type: 'GET',
data: {
context: 'view'
}
} ).done( function( data ) {
return data;
} ).fail( function( error ) {
return error;
} );
Activate a specific Signup
Arguments
| Name | Type | Description |
|---|---|---|
| activation_key | string | Activation key of the signup. Required |
| context | string | Scope under which the request is made; determines fields present in response. Default: editOne of: view, edit |
Definition
PUT /buddypress/v1/signup/activate/<activation_key>
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/signup/activate/1f56ce56bf66ef53',
type: 'PUT',
data: {
context: 'edit'
}
} ).done( function( data ) {
return data;
} ).fail( function( error ) {
return error;
} );
Delete a specific Signup
Arguments
| Name | Type | Description |
|---|---|---|
| id | string | Unique identifier for the signup. It can be a signup ID, an email address, or most likely an activation key. Required |
| context | string | Scope under which the request is made; determines fields present in response. Default: editOne of: view, edit |
Definition
DELETE /buddypress/v1/signup/<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/signup/1f56ce56bf66ef53', // Activation key.
type: 'DELETE',
data: {
context: 'edit',
}
} ).done( function( data ) {
return data;
} ).fail( function( error ) {
return error;
} );