[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-settings/ -> bp-settings-functions.php (summary)

BuddyPress Settings Functions

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

Defines 10 functions

  bp_settings_update_notification_settings()
  bp_settings_sanitize_notification_settings()
  bp_settings_get_registered_notification_keys()
  bp_settings_personal_data_exporter()
  bp_settings_get_personal_data_request()
  bp_settings_get_personal_data_expiration_date()
  bp_settings_get_personal_data_confirmation_date()
  bp_settings_get_personal_data_export_url()
  bp_settings_personal_data_export_exists()
  bp_settings_data_exporter_items()

Functions
Functions that are not part of a class:

bp_settings_update_notification_settings( $user_id, $settings )   X-Ref
Update email notification settings for a specific user.

since: 2.3.5
param: int   $user_id  ID of the user whose settings are being updated.
param: array $settings Settings array.

bp_settings_sanitize_notification_settings( $settings = array()   X-Ref
Sanitize email notification settings as submitted by a user.

since: 2.3.5
return: array Sanitized settings.
param: array $settings Array of settings.

bp_settings_get_registered_notification_keys()   X-Ref
Build a dynamic whitelist of notification keys, based on what's hooked to 'bp_notification_settings'.

since: 2.3.5
return: array

bp_settings_personal_data_exporter( $email_address, $page )   X-Ref
Finds and exports personal data associated with an email address from the Settings component.

since: 4.0.0
return: array An array of personal data.
param: string $email_address  The user's email address.
param: int    $page           Batch number.

bp_settings_get_personal_data_request( $user_id = 0 )   X-Ref
Fetches a user's personal data request.

since: 4.0.0
return: WP_User_Request|false WP_User_Request object on success, boolean false on failure.
param: int WP user ID.

bp_settings_get_personal_data_expiration_date( WP_User_Request $request )   X-Ref
Fetches the expiration date for when a user request expires.

since: 4.0.0
return: string Formatted date.
param: WP_User_Request $request User request object.

bp_settings_get_personal_data_confirmation_date( WP_User_Request $request )   X-Ref
Fetches the confirmation date for a user request object.

since: 4.0.0
return: string Formatted date for the confirmation date.
param: WP_User_Request $request User request object.

bp_settings_get_personal_data_export_url( WP_User_Request $request )   X-Ref
Fetches the URL for a personal data export file.

since: 4.0.0
return: string Export file URL.
param: WP_User_Request $request User request object.

bp_settings_personal_data_export_exists( WP_User_Request $request )   X-Ref
Check if the generated data export file still exists or not.

since: 4.0.0
return: bool
param: WP_User_Request $request User request object.

bp_settings_data_exporter_items()   X-Ref
Template tag to output a list of data exporter items.

Piggybacks off of the 'wp_privacy_personal_data_exporters' filter and the
'exporter_friendly_name' key, which is meant for the admin area.

since: 4.0.0
since: 5.0.0 Looks for a potential exporter's BP/custom friendly name.



Generated: Sat Sep 21 01:01:46 2019 Cross-referenced by PHPXref 0.7.1