bp_add_optout( array $args = array() )
Add a new BP_Optout.
Description Description
Parameters Parameters
- $args
-
(Optional) An array of arguments describing the new opt-out.
- 'email_address'
(string) Email address of user who has opted out. - 'user_id'
(int) Optional. ID of user whose communication prompted the user to opt-out. - 'email_type'
(string) Optional. Name of the email type that prompted the user to opt-out. - 'date_modified'
(string) Optional. Specify a time, else now will be used.
Default value: array()
- 'email_address'
Return Return
(false|int) False on failure, ID of new (or existing) opt-out if successful.
Source Source
File: bp-core/bp-core-functions.php
Changelog Changelog
| Version | Description |
|---|---|
| 8.0.0 | Introduced. |