PHPXRef 0.7.1 : BBPress : Detail view of signups.php

[Source view] [Print] [Project Stats]

bbPress Signups This file contains functions for assisting with adding forum data to user accounts during signup, account creation, and invitation.

File Size:	286 lines (7 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 8 functions

  bbp_add_user_form_role_field()
  bbp_user_add_role_to_signup_meta()
  bbp_user_add_role_on_invite()
  bbp_user_add_role_on_register()
  bbp_user_add_role_on_activate()
  bbp_validate_signup_role()
  bbp_validate_registration_role()
  bbp_validate_activation_role()

Functions

Functions that are not part of a class:

bbp_add_user_form_role_field() X-Ref

Output the forum-role field when adding a new user

since: 2.6.0 bbPress (r6674)

bbp_user_add_role_to_signup_meta( $meta = array() X-Ref

Maybe add forum role to signup meta array

since: 2.6.0 bbPress (r6674)
param: array $meta
return: array

bbp_user_add_role_on_invite( $user_id = '', $role = '', $newuser_key = '' ) X-Ref

Add forum meta data when inviting a user to a site

since: 2.6.0 bbPress (r6674)
param: int $user_id The invited user's ID.
param: array $role The role of invited user.
param: string $newuser_key The key of the invitation.
return: void

bbp_user_add_role_on_register( $user_id = '' ) X-Ref

Single-site handler for adding a new user

since: 2.6.0 bbPress (r6674)
param: int $user_id
return: void

bbp_user_add_role_on_activate( $user_id = 0, $password = '', $meta = array() X-Ref

Multi-site handler for adding a new user

since: 2.6.0 bbPress (r6674)
param: int $user_id User ID
param: string $password User password
param: array $meta Array of metadata
return: void

bbp_validate_signup_role( $to_validate = '' ) X-Ref

Validate the Forum role during signup

This helper function performs a number of generic checks, and encapsulates
the logic used to validate if a Forum Role is valid, typically during new
user registration, but also when adding an existing user to a site in
Multisite installations.

since: 2.6.5
param: string $to_validate A role ID to validate
return: string A valid role ID, or empty string on error

bbp_validate_registration_role( $to_validate = '' ) X-Ref

Validate the Forum role during the registration process

since: 2.6.5
param: string $to_validate A role ID to validate
return: string A valid role ID, or empty string on error

bbp_validate_activation_role( $to_validate = '' ) X-Ref

Validate the Forum role during multisite activation

This function exists simply for parity with registrations, and to maintain an
intentional layer of abstraction from the more generic function it uses.

Note: this will not fire inside of wp-activate.php unless it is hooked in
during sunrise.php, and is considered an advanced use-case.

since: 2.6.5
param: string $to_validate A role ID to validate
return: string A valid role ID, or empty string on error

PHP Cross Reference of BBPress

/src/includes/users/ -> signups.php (summary)

Defines 8 functions