+
+ prepare_items();
+
+ if ( is_network_admin() ) {
+ $form_url = network_admin_url( 'admin.php' );
+ } else {
+ $form_url = bp_get_admin_url( 'tools.php' );
+ }
+
+ $form_url = add_query_arg(
+ array(
+ 'page' => 'bp-optouts',
+ ),
+ $form_url
+ );
+
+ $search_form_url = remove_query_arg(
+ array(
+ 'action',
+ 'deleted',
+ 'notdeleted',
+ 'error',
+ 'updated',
+ 'delete',
+ 'activate',
+ 'activated',
+ 'notactivated',
+ 'resend',
+ 'resent',
+ 'notresent',
+ 'do_delete',
+ 'do_activate',
+ 'do_resend',
+ 'action2',
+ '_wpnonce',
+ 'optout_ids'
+ ),
+ $_SERVER['REQUEST_URI']
+ );
+
+ ?>
+
+
+ $ids,
+ );
+ $optouts = bp_get_optouts( $args );
+ $optout_ids = wp_list_pluck( $optouts, 'id' );
+
+ // Check optout IDs and set up strings.
+ switch ( $action ) {
+ case 'delete' :
+ if ( 1 == count( $optouts ) ) {
+ $helper_text = __( 'You are about to delete the following opt-out request:', 'buddypress' );
+ } else {
+ $helper_text = __( 'You are about to delete the following opt-out requests:', 'buddypress' );
+ }
+ break;
+ }
+
+ // These arguments are added to all URLs.
+ $url_args = array( 'page' => 'bp-optouts' );
+
+ // These arguments are only added when performing an action.
+ $action_args = array(
+ 'action' => 'do_' . $action,
+ 'optout_ids' => implode( ',', $optout_ids )
+ );
+
+ if ( is_network_admin() ) {
+ $base_url = network_admin_url( 'admin.php' );
+ } else {
+ $base_url = bp_get_admin_url( 'tools.php' );
+ }
+
+ $cancel_url = add_query_arg( $url_args, $base_url );
+ $action_url = wp_nonce_url(
+ add_query_arg(
+ array_merge( $url_args, $action_args ),
+ $base_url
+ ),
+ 'optouts_' . $action
+ );
+
+ ?>
+
+
+
+ get_charset_collate();
+ $bp_prefix = bp_core_get_table_prefix();
+ $optouts_class = new BP_Optout();
+ $table_name = $optouts_class->get_table_name();
+ $sql = "CREATE TABLE {$table_name} (
+ id bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY,
+ email_address_hash varchar(255) NOT NULL,
+ user_id bigint(20) NOT NULL,
+ email_type varchar(255) NOT NULL,
+ date_modified datetime NOT NULL,
+ KEY user_id (user_id),
+ KEY email_type (email_type),
+ KEY date_modified (date_modified)
+ ) {$charset_collate};";
+ dbDelta( $sql );
+
+ /**
+ * Fires after BuddyPress adds the nonmember opt-outs table.
+ *
+ * @since 8.0.0
+ */
+ do_action( 'bp_core_install_nonmember_opt_outs' );
+}
diff --git src/bp-core/admin/bp-core-admin-tools.php src/bp-core/admin/bp-core-admin-tools.php
index 0d49c0d6f..8141eccbe 100644
--- src/bp-core/admin/bp-core-admin-tools.php
+++ src/bp-core/admin/bp-core-admin-tools.php
@@ -22,6 +22,8 @@ function bp_core_admin_tools() {
@@ -541,18 +543,34 @@ function bp_core_admin_available_tools_intro() {
$page = bp_core_do_network_admin() ? 'admin.php' : 'tools.php' ;
$url = add_query_arg( $query_arg, bp_get_admin_url( $page ) );
?>
-
+
'',
+ 'user_id' => 0,
+ 'email_type' => '',
+ 'date_modified' => bp_core_current_time(),
+ ),
+ 'add_optout'
+ );
+
+ // Opt-outs must have an email address.
+ if ( empty( $r['email_address'] ) ) {
+ return false;
+ }
+
+ // Avoid creating duplicate opt-outs.
+ $optout_id = $optout->optout_exists(
+ array(
+ 'email_address' => $r['email_address'],
+ 'user_id' => $r['user_id'],
+ 'email_type' => $r['email_type'],
+ )
+ );
+
+ if ( ! $optout_id ) {
+ // Set up the new opt-out.
+ $optout->email_address = $r['email_address'];
+ $optout->user_id = $r['user_id'];
+ $optout->email_type = $r['email_type'];
+ $optout->date_modified = $r['date_modified'];
+
+ $optout_id = $optout->save();
+ }
+
+ return $optout_id;
+}
+
+/**
+ * Find matching BP_Optouts.
+ *
+ * @since 8.0.0
+ *
+ * @see BP_Optout::get() for a description of parameters and return values.
+ *
+ * @param array $args See {@link BP_Optout::get()}.
+ * @return array See {@link BP_Optout::get()}.
+ */
+function bp_get_optouts( $args = array() ) {
+ $optout_class = new BP_Optout();
+ return $optout_class::get( $args );
+}
+
+/**
+ * Delete a BP_Optout by ID.
+ *
+ * @since 8.0.0
+ *
+ * @param int $id ID of the optout to delete.
+ * @return bool True on success, false on failure.
+ */
+function bp_delete_optout_by_id( $id = 0 ) {
+ $optout_class = new BP_Optout();
+ return $optout_class::delete_by_id( $id );
+}
diff --git src/bp-core/bp-core-update.php src/bp-core/bp-core-update.php
index 7cb66c837..1556f6146 100644
--- src/bp-core/bp-core-update.php
+++ src/bp-core/bp-core-update.php
@@ -651,6 +651,8 @@ function bp_update_to_8_0() {
}
}
}
+
+ bp_core_install_nonmember_opt_outs();
}
/**
diff --git src/bp-core/classes/class-bp-admin.php src/bp-core/classes/class-bp-admin.php
index 617c7d90a..1e10deab7 100644
--- src/bp-core/classes/class-bp-admin.php
+++ src/bp-core/classes/class-bp-admin.php
@@ -123,6 +123,7 @@ class BP_Admin {
require( $this->admin_dir . 'bp-core-admin-components.php' );
require( $this->admin_dir . 'bp-core-admin-slugs.php' );
require( $this->admin_dir . 'bp-core-admin-tools.php' );
+ require( $this->admin_dir . 'bp-core-admin-optouts.php' );
}
/**
@@ -301,6 +302,15 @@ class BP_Admin {
'bp_core_admin_tools'
);
+ $hooks[] = add_submenu_page(
+ $tools_parent,
+ __( 'Manage Opt-outs', 'buddypress' ),
+ __( 'Manage Opt-outs', 'buddypress' ),
+ $this->capability,
+ 'bp-optouts',
+ 'bp_core_optouts_admin'
+ );
+
// For network-wide configs, add a link to (the root site's) Emails screen.
if ( is_network_admin() && bp_is_network_activated() ) {
$email_labels = bp_get_email_post_type_labels();
@@ -523,6 +533,13 @@ class BP_Admin {
// About and Credits pages.
remove_submenu_page( 'index.php', 'bp-about' );
remove_submenu_page( 'index.php', 'bp-credits' );
+
+ // Nonmembers Opt-outs page.
+ if ( is_network_admin() ) {
+ remove_submenu_page( 'network-tools', 'bp-optouts' );
+ } else {
+ remove_submenu_page( 'tools.php', 'bp-optouts' );
+ }
}
/**
diff --git src/bp-core/classes/class-bp-optout.php src/bp-core/classes/class-bp-optout.php
new file mode 100644
index 000000000..90dff5f83
--- /dev/null
+++ src/bp-core/classes/class-bp-optout.php
@@ -0,0 +1,824 @@
+id = (int) $id;
+ $this->populate();
+ }
+ }
+
+ /**
+ * Get the opt-outs table name.
+ *
+ * @since 8.0.0
+ * @access public
+ * @return string
+ */
+ public static function get_table_name() {
+ return buddypress()->members->table_name_optouts;
+ }
+
+ /**
+ * Update or insert opt-out details into the database.
+ *
+ * @since 8.0.0
+ *
+ * @global wpdb $wpdb WordPress database object.
+ *
+ * @return bool True on success, false on failure.
+ */
+ public function save() {
+
+ // Return value
+ $retval = false;
+
+ // Default data and format
+ $data = array(
+ 'email_address_hash' => $this->email_address,
+ 'user_id' => $this->user_id,
+ 'email_type' => sanitize_key( $this->email_type ),
+ 'date_modified' => $this->date_modified,
+ );
+ $data_format = array( '%s', '%d', '%s', '%s' );
+
+ /**
+ * Fires before an opt-out is saved.
+ *
+ * @since 8.0.0
+ *
+ * @param BP_Optout object $this Characteristics of the opt-out to be saved.
+ */
+ do_action_ref_array( 'bp_optout_before_save', array( &$this ) );
+
+ // Update.
+ if ( ! empty( $this->id ) ) {
+ $result = self::_update( $data, array( 'ID' => $this->id ), $data_format, array( '%d' ) );
+ // Insert.
+ } else {
+ $result = self::_insert( $data, $data_format );
+ }
+
+ // Set the opt-out ID if successful.
+ if ( ! empty( $result ) && ! is_wp_error( $result ) ) {
+ global $wpdb;
+
+ $this->id = $wpdb->insert_id;
+ $retval = $wpdb->insert_id;
+ }
+
+ wp_cache_delete( $this->id, 'bp_optouts' );
+
+ /**
+ * Fires after an optout is saved.
+ *
+ * @since 8.0.0
+ *
+ * @param BP_optout object $this Characteristics of the opt-out just saved.
+ */
+ do_action_ref_array( 'bp_optout_after_save', array( &$this ) );
+
+ // Return the result.
+ return $retval;
+ }
+
+ /**
+ * Fetch data for an existing opt-out from the database.
+ *
+ * @since 8.0.0
+ *
+ * @global BuddyPress $bp The one true BuddyPress instance.
+ * @global wpdb $wpdb WordPress database object.
+ */
+ public function populate() {
+ global $wpdb;
+ $optouts_table_name = $this->get_table_name();
+
+ // Check cache for optout data.
+ $optout = wp_cache_get( $this->id, 'bp_optouts' );
+
+ // Cache missed, so query the DB.
+ if ( false === $optout ) {
+ $optout = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$optouts_table_name} WHERE id = %d", $this->id ) );
+ wp_cache_set( $this->id, $optout, 'bp_optouts' );
+ }
+
+ // No optout found so set the ID and bail.
+ if ( empty( $optout ) || is_wp_error( $optout ) ) {
+ $this->id = 0;
+ return;
+ }
+
+ $this->email_address = $optout->email_address_hash;
+ $this->user_id = (int) $optout->user_id;
+ $this->email_type = sanitize_key( $optout->email_type );
+ $this->date_modified = $optout->date_modified;
+
+ }
+
+ /** Protected Static Methods ******************************************/
+
+ /**
+ * Create an opt-out entry.
+ *
+ * @since 8.0.0
+ *
+ * @param array $data {
+ * Array of optout data, passed to {@link wpdb::insert()}.
+ * @type string $email_address The hashed email address of the user that wishes to opt out of
+ * communications from this site.
+ * @type int $user_id The ID of the user that generated the contact that resulted in the opt-out.
+ * @type string $email_type The type of email contact that resulted in the opt-out.
+ * @type string $date_modified Date the opt-out was last modified.
+ * }
+ * @param array $data_format See {@link wpdb::insert()}.
+ * @return int|false The number of rows inserted, or false on error.
+ */
+ protected static function _insert( $data = array(), $data_format = array() ) {
+ global $wpdb;
+ // We must hash the email address at insert.
+ $data['email_address_hash'] = wp_hash( $data['email_address_hash'] );
+ return $wpdb->insert( BP_Optout::get_table_name(), $data, $data_format );
+ }
+
+ /**
+ * Update opt-outs.
+ *
+ * @since 8.0.0
+ *
+ * @see wpdb::update() for further description of paramater formats.
+ *
+ * @param array $data Array of opt-out data to update, passed to
+ * {@link wpdb::update()}. Accepts any property of a
+ * BP_optout object.
+ * @param array $where The WHERE params as passed to wpdb::update().
+ * Typically consists of array( 'ID' => $id ) to specify the ID
+ * of the item being updated. See {@link wpdb::update()}.
+ * @param array $data_format See {@link wpdb::insert()}.
+ * @param array $where_format See {@link wpdb::insert()}.
+ * @return int|false The number of rows updated, or false on error.
+ */
+ protected static function _update( $data = array(), $where = array(), $data_format = array(), $where_format = array() ) {
+ global $wpdb;
+
+ // Ensure that a passed email address is hashed.
+ if ( ! empty( $data['email_address_hash'] ) && is_email( $data['email_address_hash'] ) ) {
+ $data['email_address_hash'] = wp_hash( $data['email_address_hash'] );
+ }
+
+ return $wpdb->update( BP_Optout::get_table_name(), $data, $where, $data_format, $where_format );
+ }
+
+ /**
+ * Delete opt-outs.
+ *
+ * @since 8.0.0
+ *
+ * @see wpdb::update() for further description of paramater formats.
+ *
+ * @param array $where Array of WHERE clauses to filter by, passed to
+ * {@link wpdb::delete()}. Accepts any property of a
+ * BP_optout object.
+ * @param array $where_format See {@link wpdb::insert()}.
+ * @return int|false The number of rows updated, or false on error.
+ */
+ protected static function _delete( $where = array(), $where_format = array() ) {
+ global $wpdb;
+ return $wpdb->delete( BP_Optout::get_table_name(), $where, $where_format );
+ }
+
+ /**
+ * Assemble the WHERE clause of a get() SQL statement.
+ *
+ * Used by BP_optout::get() to create its WHERE
+ * clause.
+ *
+ * @since 8.0.0
+ *
+ * @param array $args See {@link BP_optout::get()} for more details.
+ * @return string WHERE clause.
+ */
+ protected static function get_where_sql( $args = array() ) {
+ global $wpdb;
+
+ $where_conditions = array();
+ $where = '';
+
+ // id.
+ if ( false !== $args['id'] ) {
+ $id_in = implode( ',', wp_parse_id_list( $args['id'] ) );
+ $where_conditions['id'] = "id IN ({$id_in})";
+ }
+
+ // email_address.
+ if ( ! empty( $args['email_address'] ) ) {
+ if ( ! is_array( $args['email_address'] ) ) {
+ $emails = explode( ',', $args['email_address'] );
+ } else {
+ $emails = $args['email_address'];
+ }
+
+ $email_clean = array();
+ foreach ( $emails as $email ) {
+ $email_hash = wp_hash( $email );
+ $email_clean[] = $wpdb->prepare( '%s', $email_hash );
+ }
+
+ $email_in = implode( ',', $email_clean );
+ $where_conditions['email_address'] = "email_address_hash IN ({$email_in})";
+ }
+
+ // user_id.
+ if ( ! empty( $args['user_id'] ) ) {
+ $user_id_in = implode( ',', wp_parse_id_list( $args['user_id'] ) );
+ $where_conditions['user_id'] = "user_id IN ({$user_id_in})";
+ }
+
+ // email_type.
+ if ( ! empty( $args['email_type'] ) ) {
+ if ( ! is_array( $args['email_type'] ) ) {
+ $email_types = explode( ',', $args['email_type'] );
+ } else {
+ $email_types = $args['email_type'];
+ }
+
+ $et_clean = array();
+ foreach ( $email_types as $et ) {
+ $et_clean[] = $wpdb->prepare( '%s', sanitize_key( $et ) );
+ }
+
+ $et_in = implode( ',', $et_clean );
+ $where_conditions['email_type'] = "email_type IN ({$et_in})";
+ }
+
+ // search_terms.
+ if ( ! empty( $args['search_terms'] ) ) {
+ // Matching email_address is an exact match because of the hashing.
+ $search_terms_like = wp_hash( $args['search_terms'] );
+ $where_conditions['search_terms'] = $wpdb->prepare( '( email_address_hash LIKE %s )', $search_terms_like );
+ }
+
+ // Custom WHERE.
+ if ( ! empty( $where_conditions ) ) {
+ $where = 'WHERE ' . implode( ' AND ', $where_conditions );
+ }
+
+ return $where;
+ }
+
+ /**
+ * Assemble the ORDER BY clause of a get() SQL statement.
+ *
+ * Used by BP_Optout::get() to create its ORDER BY
+ * clause.
+ *
+ * @since 8.0.0
+ *
+ * @param array $args See {@link BP_optout::get()} for more details.
+ * @return string ORDER BY clause.
+ */
+ protected static function get_order_by_sql( $args = array() ) {
+
+ $conditions = array();
+ $retval = '';
+
+ // Order by.
+ if ( ! empty( $args['order_by'] ) ) {
+ $order_by_clean = array();
+ $columns = array( 'id', 'email_address_hash', 'user_id', 'email_type', 'date_modified' );
+ foreach ( (array) $args['order_by'] as $key => $value ) {
+ if ( in_array( $value, $columns, true ) ) {
+ $order_by_clean[] = $value;
+ }
+ }
+ if ( ! empty( $order_by_clean ) ) {
+ $order_by = implode( ', ', $order_by_clean );
+ $conditions['order_by'] = "{$order_by}";
+ }
+ }
+
+ // Sort order direction.
+ if ( ! empty( $args['sort_order'] ) ) {
+ $sort_order = bp_esc_sql_order( $args['sort_order'] );
+ $conditions['sort_order'] = "{$sort_order}";
+ }
+
+ // Custom ORDER BY.
+ if ( ! empty( $conditions['order_by'] ) ) {
+ $retval = 'ORDER BY ' . implode( ' ', $conditions );
+ }
+
+ return $retval;
+ }
+
+ /**
+ * Assemble the LIMIT clause of a get() SQL statement.
+ *
+ * Used by BP_Optout::get() to create its LIMIT clause.
+ *
+ * @since 8.0.0
+ *
+ * @param array $args See {@link BP_optout::get()} for more details.
+ * @return string LIMIT clause.
+ */
+ protected static function get_paged_sql( $args = array() ) {
+ global $wpdb;
+
+ // Setup local variable.
+ $retval = '';
+
+ // Custom LIMIT.
+ if ( ! empty( $args['page'] ) && ! empty( $args['per_page'] ) ) {
+ $page = absint( $args['page'] );
+ $per_page = absint( $args['per_page'] );
+ $offset = $per_page * ( $page - 1 );
+ $retval = $wpdb->prepare( "LIMIT %d, %d", $offset, $per_page );
+ }
+
+ return $retval;
+ }
+
+ /**
+ * Assemble query clauses, based on arguments, to pass to $wpdb methods.
+ *
+ * The insert(), update(), and delete() methods of {@link wpdb} expect
+ * arguments of the following forms:
+ *
+ * - associative arrays whose key/value pairs are column => value, to
+ * be used in WHERE, SET, or VALUES clauses
+ * - arrays of "formats", which tell $wpdb->prepare() which type of
+ * value to expect when sanitizing (eg, array( '%s', '%d' ))
+ *
+ * This utility method can be used to assemble both kinds of params,
+ * out of a single set of associative array arguments, such as:
+ *
+ * $args = array(
+ * 'user_id' => 4,
+ * 'email_type' => 'type_string',
+ * );
+ *
+ * This will be converted to:
+ *
+ * array(
+ * 'data' => array(
+ * 'user_id' => 4,
+ * 'email_type' => 'type_string',
+ * ),
+ * 'format' => array(
+ * '%d',
+ * '%s',
+ * ),
+ * )
+ *
+ * which can easily be passed as arguments to the $wpdb methods.
+ *
+ * @since 8.0.0
+ *
+ * @param array $args Associative array of filter arguments.
+ * See {@BP_optout::get()} for a breakdown.
+ * @return array Associative array of 'data' and 'format' args.
+ */
+ protected static function get_query_clauses( $args = array() ) {
+ $where_clauses = array(
+ 'data' => array(),
+ 'format' => array(),
+ );
+
+ // id.
+ if ( ! empty( $args['id'] ) ) {
+ $where_clauses['data']['id'] = absint( $args['id'] );
+ $where_clauses['format'][] = '%d';
+ }
+
+ // email_address.
+ if ( ! empty( $args['email_address'] ) ) {
+ $where_clauses['data']['email_address_hash'] = $args['email_address'];
+ $where_clauses['format'][] = '%s';
+ }
+
+ // user_id.
+ if ( ! empty( $args['user_id'] ) ) {
+ $where_clauses['data']['user_id'] = absint( $args['user_id'] );
+ $where_clauses['format'][] = '%d';
+ }
+
+ // email_type.
+ if ( ! empty( $args['email_type'] ) ) {
+ $where_clauses['data']['email_type'] = $args['email_type'];
+ $where_clauses['format'][] = '%s';
+ }
+
+ return $where_clauses;
+ }
+
+ /** Public Static Methods *********************************************/
+
+ /**
+ * Get opt-outs, based on provided filter parameters.
+ *
+ * @since 8.0.0
+ *
+ * @param array $args {
+ * Associative array of arguments. All arguments but $page and
+ * $per_page can be treated as filter values for get_where_sql()
+ * and get_query_clauses(). All items are optional.
+ * @type int|array $id ID of opt-out.
+ * Can be an array of IDs.
+ * @type string|array $email_address Email address of users who have opted out
+ * being queried. Can be an array of addresses.
+ * @type int|array $user_id ID of user whose communication prompted the
+ * opt-out. Can be an array of IDs.
+ * @type string|array $email_type Name of the emil type to filter by.
+ * Can be an array of email types.
+ * @type string $search_terms Term to match against email_address field.
+ * @type string $order_by Database column to order by.
+ * @type string $sort_order Either 'ASC' or 'DESC'.
+ * @type int $page Number of the current page of results.
+ * Default: false (no pagination,
+ * all items).
+ * @type int $per_page Number of items to show per page.
+ * Default: false (no pagination,
+ * all items).
+ * @type string $fields Which fields to return. Specify 'email_addresses' to
+ * fetch a list of opt-out email_addresses.
+ * Specify 'user_ids' to
+ * fetch a list of opt-out user_ids.
+ * Specify 'ids' to fetch a list of opt-out IDs.
+ * Default: 'all' (return BP_Optout objects).
+ * }
+ *
+ * @return array BP_Optout objects | IDs of found opt-outs | Email addresses of matches.
+ */
+ public static function get( $args = array() ) {
+ global $wpdb;
+ $optouts_table_name = BP_Optout::get_table_name();
+
+ // Parse the arguments.
+ $r = bp_parse_args(
+ $args,
+ array(
+ 'id' => false,
+ 'email_address' => false,
+ 'user_id' => false,
+ 'email_type' => false,
+ 'search_terms' => '',
+ 'order_by' => false,
+ 'sort_order' => false,
+ 'page' => false,
+ 'per_page' => false,
+ 'fields' => 'all',
+ ),
+ 'bp_optout_get'
+ );
+
+ $sql = array(
+ 'select' => "SELECT",
+ 'fields' => '',
+ 'from' => "FROM {$optouts_table_name} o",
+ 'where' => '',
+ 'orderby' => '',
+ 'pagination' => '',
+ );
+
+ if ( 'user_ids' === $r['fields'] ) {
+ $sql['fields'] = "DISTINCT o.user_id";
+ } else if ( 'email_addresses' === $r['fields'] ) {
+ $sql['fields'] = "DISTINCT o.email_address_hash";
+ } else {
+ $sql['fields'] = 'DISTINCT o.id';
+ }
+
+ // WHERE.
+ $sql['where'] = self::get_where_sql(
+ array(
+ 'id' => $r['id'],
+ 'email_address' => $r['email_address'],
+ 'user_id' => $r['user_id'],
+ 'email_type' => $r['email_type'],
+ 'search_terms' => $r['search_terms'],
+ )
+ );
+
+ // ORDER BY.
+ $sql['orderby'] = self::get_order_by_sql(
+ array(
+ 'order_by' => $r['order_by'],
+ 'sort_order' => $r['sort_order']
+ )
+ );
+
+ // LIMIT %d, %d.
+ $sql['pagination'] = self::get_paged_sql(
+ array(
+ 'page' => $r['page'],
+ 'per_page' => $r['per_page'],
+ )
+ );
+
+ $paged_optouts_sql = "{$sql['select']} {$sql['fields']} {$sql['from']} {$sql['where']} {$sql['orderby']} {$sql['pagination']}";
+
+ /**
+ * Filters the pagination SQL statement.
+ *
+ * @since 8.0.0
+ *
+ * @param string $value Concatenated SQL statement.
+ * @param array $sql Array of SQL parts before concatenation.
+ * @param array $r Array of parsed arguments for the get method.
+ */
+ $paged_optouts_sql = apply_filters( 'bp_optouts_get_paged_optouts_sql', $paged_optouts_sql, $sql, $r );
+
+ $cached = bp_core_get_incremented_cache( $paged_optouts_sql, 'bp_optouts' );
+ if ( false === $cached ) {
+ $paged_optout_ids = $wpdb->get_col( $paged_optouts_sql );
+ bp_core_set_incremented_cache( $paged_optouts_sql, 'bp_optouts', $paged_optout_ids );
+ } else {
+ $paged_optout_ids = $cached;
+ }
+
+ // Special return format cases.
+ if ( in_array( $r['fields'], array( 'ids', 'user_ids' ), true ) ) {
+ // We only want the field that was found.
+ return array_map( 'intval', $paged_optout_ids );
+ } else if ( 'email_addresses' === $r['fields'] ) {
+ return $paged_optout_ids;
+ }
+
+ $uncached_ids = bp_get_non_cached_ids( $paged_optout_ids, 'bp_optouts' );
+ if ( $uncached_ids ) {
+ $ids_sql = implode( ',', array_map( 'intval', $uncached_ids ) );
+ $data_objects = $wpdb->get_results( "SELECT o.* FROM {$optouts_table_name} o WHERE o.id IN ({$ids_sql})" );
+ foreach ( $data_objects as $data_object ) {
+ wp_cache_set( $data_object->id, $data_object, 'bp_optouts' );
+ }
+ }
+
+ $paged_optouts = array();
+ foreach ( $paged_optout_ids as $paged_optout_id ) {
+ $paged_optouts[] = new BP_optout( $paged_optout_id );
+ }
+
+ return $paged_optouts;
+ }
+
+ /**
+ * Get a count of total optouts matching a set of arguments.
+ *
+ * @since 8.0.0
+ *
+ * @see BP_optout::get() for a description of
+ * arguments.
+ *
+ * @param array $args See {@link BP_optout::get()}.
+ * @return int Count of located items.
+ */
+ public static function get_total_count( $args ) {
+ global $wpdb;
+ $optouts_table_name = BP_Optout::get_table_name();
+
+ // Parse the arguments.
+ $r = bp_parse_args(
+ $args,
+ array(
+ 'id' => false,
+ 'email_address' => false,
+ 'user_id' => false,
+ 'email_type' => false,
+ 'search_terms' => '',
+ 'order_by' => false,
+ 'sort_order' => false,
+ 'page' => false,
+ 'per_page' => false,
+ 'fields' => 'all',
+ ),
+ 'bp_optout_get_total_count'
+ );
+
+ // Build the query
+ $select_sql = "SELECT COUNT(*)";
+ $from_sql = "FROM {$optouts_table_name}";
+ $where_sql = self::get_where_sql( $r );
+ $sql = "{$select_sql} {$from_sql} {$where_sql}";
+
+ // Return the queried results
+ return $wpdb->get_var( $sql );
+ }
+
+ /**
+ * Update optouts.
+ *
+ * @since 8.0.0
+ *
+ * @see BP_optout::get() for a description of
+ * accepted update/where arguments.
+ *
+ * @param array $update_args Associative array of fields to update,
+ * and the values to update them to. Of the format
+ * array( 'user_id' => 4, 'email_address' => 'bar@foo.com', ).
+ * @param array $where_args Associative array of columns/values, to
+ * determine which rows should be updated. Of the format
+ * array( 'user_id' => 7, 'email_address' => 'bar@foo.com', ).
+ * @return int|bool Number of rows updated on success, false on failure.
+ */
+ public static function update( $update_args = array(), $where_args = array() ) {
+ $update = self::get_query_clauses( $update_args );
+ $where = self::get_query_clauses( $where_args );
+
+ /**
+ * Fires before an opt-out is updated.
+ *
+ * @since 8.0.0
+ *
+ * @param array $where_args Associative array of columns/values describing
+ * opt-outs about to be deleted.
+ * @param array $update_args Array of new values.
+ */
+ do_action( 'bp_optout_before_update', $where_args, $update_args );
+
+ $retval = self::_update( $update['data'], $where['data'], $update['format'], $where['format'] );
+
+ // Clear matching items from the cache.
+ $cache_args = $where_args;
+ $cache_args['fields'] = 'ids';
+ $maybe_cached_ids = self::get( $cache_args );
+ foreach ( $maybe_cached_ids as $invite_id ) {
+ wp_cache_delete( $invite_id, 'bp_optouts' );
+ }
+
+ /**
+ * Fires after an opt-out is updated.
+ *
+ * @since 8.0.0
+ *
+ * @param array $where_args Associative array of columns/values describing
+ * opt-outs about to be deleted.
+ * @param array $update_args Array of new values.
+ */
+ do_action( 'bp_optout_after_update', $where_args, $update_args );
+
+ return $retval;
+ }
+
+ /**
+ * Delete opt-outs.
+ *
+ * @since 8.0.0
+ *
+ * @see BP_optout::get() for a description of
+ * accepted where arguments.
+ *
+ * @param array $args Associative array of columns/values, to determine
+ * which rows should be deleted. Of the format
+ * array( 'user_id' => 7, 'email_address' => 'bar@foo.com', ).
+ * @return int|bool Number of rows deleted on success, false on failure.
+ */
+ public static function delete( $args = array() ) {
+ $where = self::get_query_clauses( $args );
+
+ /**
+ * Fires before an opt-out is deleted.
+ *
+ * @since 8.0.0
+ *
+ * @param array $args Characteristics of the opt-outs to be deleted.
+ */
+ do_action( 'bp_optout_before_delete', $args );
+
+ // Clear matching items from the cache.
+ $cache_args = $args;
+ $cache_args['fields'] = 'ids';
+ $maybe_cached_ids = self::get( $cache_args );
+ foreach ( $maybe_cached_ids as $invite_id ) {
+ wp_cache_delete( $invite_id, 'bp_optouts' );
+ }
+
+ $retval = self::_delete( $where['data'], $where['format'] );
+
+ /**
+ * Fires after an opt-out is deleted.
+ *
+ * @since 8.0.0
+ *
+ * @param array $args Characteristics of the opt-outs just deleted.
+ */
+ do_action( 'bp_optout_after_delete', $args );
+
+ return $retval;
+ }
+
+ /** Convenience methods ***********************************************/
+
+ /**
+ * Check whether an invitation exists matching the passed arguments.
+ *
+ * @since 5.0.0
+ *
+ * @see BP_Optout::get() for a description of accepted parameters.
+ *
+ * @return int|bool ID of first found invitation or false if none found.
+ */
+ public function optout_exists( $args = array() ) {
+ $exists = false;
+
+ $args['fields'] = 'ids';
+ $optouts = BP_Optout::get( $args );
+ if ( $optouts ) {
+ $exists = current( $optouts );
+ }
+
+ return $exists;
+ }
+
+ /**
+ * Delete a single opt-out by ID.
+ *
+ * @since 8.0.0
+ *
+ * @see BP_optout::delete() for explanation of
+ * return value.
+ *
+ * @param int $id ID of the opt-out item to be deleted.
+ * @return bool True on success, false on failure.
+ */
+ public static function delete_by_id( $id ) {
+ return self::delete( array(
+ 'id' => $id,
+ ) );
+ }
+}
diff --git src/bp-core/classes/class-bp-optouts-list-table.php src/bp-core/classes/class-bp-optouts-list-table.php
new file mode 100644
index 000000000..0e9084245
--- /dev/null
+++ src/bp-core/classes/class-bp-optouts-list-table.php
@@ -0,0 +1,393 @@
+ false,
+ 'plural' => 'optouts',
+ 'singular' => 'optout',
+ 'screen' => get_current_screen()->id,
+ )
+ );
+ }
+
+ /**
+ * Set up items for display in the list table.
+ *
+ * Handles filtering of data, sorting, pagination, and any other data
+ * manipulation required prior to rendering.
+ *
+ * @since 8.0.0
+ */
+ public function prepare_items() {
+ global $usersearch;
+
+ $search = isset( $_REQUEST['s'] ) ? $_REQUEST['s'] : '';
+ $per_page = $this->get_items_per_page( str_replace( '-', '_', "{$this->screen->id}_per_page" ) );
+ $paged = $this->get_pagenum();
+
+ $args = array(
+ 'search_terms' => $search,
+ 'order_by' => 'date_modified',
+ 'sort_order' => 'DESC',
+ 'page' => $paged,
+ 'per_page' => $per_page,
+ );
+
+ if ( isset( $_REQUEST['orderby'] ) ) {
+ $args['order_by'] = $_REQUEST['orderby'];
+ }
+
+ if ( isset( $_REQUEST['order'] ) ) {
+ $args['sort_order'] = $_REQUEST['order'];
+ }
+
+ $this->items = bp_get_optouts( $args );
+ $optouts_class = new BP_Optout();
+ $this->total_items = $optouts_class->get_total_count( $args );
+
+ $this->set_pagination_args(
+ array(
+ 'total_items' => $this->total_items,
+ 'per_page' => $per_page,
+ )
+ );
+ }
+
+ /**
+ * Get the list of views available on this table.
+ *
+ * @since 8.0.0
+ */
+ public function views() {
+ if ( is_multisite() && bp_core_do_network_admin() ) {
+ $tools_parent = 'admin.php';
+ } else {
+ $tools_parent = 'tools.php';
+ }
+
+ $url_base = add_query_arg(
+ array(
+ 'page' => 'bp-optouts',
+ ),
+ bp_get_admin_url( $tools_parent )
+ );
+ ?>
+
+
+
+
+
+ '
',
+ 'email_address' => __( 'Email Address Hash', 'buddypress' ),
+ 'username' => __( 'Email Sender', 'buddypress' ),
+ 'user_registered' => __( 'Email Sender Registered', 'buddypress' ),
+ 'email_type' => __( 'Email Type', 'buddypress' ),
+ 'email_type_description' => __( 'Email Description', 'buddypress' ),
+ 'optout_date_modified' => __( 'Date Modified', 'buddypress' ),
+ )
+ );
+ }
+
+ /**
+ * Specific bulk actions for opt-outs.
+ *
+ * @since 8.0.0
+ */
+ public function get_bulk_actions() {
+ if ( current_user_can( 'delete_users' ) ) {
+ $actions['delete'] = _x( 'Delete', 'Optout database record action', 'buddypress' );
+ }
+
+ return $actions;
+ }
+
+ /**
+ * The text shown when no items are found.
+ *
+ * Nice job, clean sheet!
+ *
+ * @since 8.0.0
+ */
+ public function no_items() {
+ esc_html_e( 'No opt-outs found.', 'buddypress' );
+ }
+
+ /**
+ * The columns opt-outs can be reordered by.
+ *
+ * @since 8.0.0
+ */
+ public function get_sortable_columns() {
+ return array(
+ 'username' => 'user_id',
+ 'email_type' => 'email_type',
+ 'optout_date_modified' => 'date_modified',
+ );
+ }
+
+ /**
+ * Display opt-out rows.
+ *
+ * @since 8.0.0
+ */
+ public function display_rows() {
+ $style = '';
+ foreach ( $this->items as $optout ) {
+ $style = ( ' class="alternate"' == $style ) ? '' : ' class="alternate"';
+ echo "\n\t" . $this->single_row( $optout, $style );
+ }
+ }
+
+ /**
+ * Display an opt-out row.
+ *
+ * @since 8.0.0
+ *
+ * @see WP_List_Table::single_row() for explanation of params.
+ *
+ * @param BP_Optout $optout BP_Optout object.
+ * @param string $style Styles for the row.
+ * @param string $role Role to be assigned to user.
+ * @param int $numposts Number of posts.
+ * @return void
+ */
+ public function single_row( $optout = null, $style = '', $role = '', $numposts = 0 ) {
+ echo '
';
+ echo $this->single_row_columns( $optout );
+ echo '';
+ }
+
+ /**
+ * Markup for the checkbox used to select items for bulk actions.
+ *
+ * @since 8.0.0
+ *
+ * @param BP_Optout $optout BP_Optout object.
+ */
+ public function column_cb( $optout = null ) {
+ ?>
+
+ id ) );
+ ?>
+
+ %2$s ', esc_url( $delete_link ), esc_html__( 'Delete', 'buddypress' ) );
+
+ /**
+ * Filters the row actions for each opt-out in list.
+ *
+ * @since 8.0.0
+ *
+ * @param array $actions Array of actions and corresponding links.
+ * @param object $optout The BP_Optout.
+ */
+ $actions = apply_filters( 'bp_optouts_management_row_actions', $actions, $optout );
+
+ echo $this->row_actions( $actions );
+ }
+
+ /**
+ * The inviter/site member who sent the email that prompted the opt-out.
+ *
+ * @since 8.0.0
+ *
+ * @param BP_Optout $optout BP_Optout object.
+ */
+ public function column_username( $optout = null ) {
+ $avatar = get_avatar( $optout->user_id, 32 );
+ $inviter = get_user_by( 'id', $optout->user_id );
+ if ( ! $inviter ) {
+ return;
+ }
+ $user_link = bp_core_get_user_domain( $optout->user_id );
+ echo $avatar . sprintf( '%2$s