Changeset 12898 for trunk/src/bp-core/admin/bp-core-admin-schema.php

Timestamp:

04/20/2021 04:02:43 PM (5 years ago)

Author:

dcavins

Message:

Introduce BP_Optouts.

Add capability to store opt-out requests from
nonmembers who have been contacted by
communication from a BuddyPress site. These
new objects are represented by the class BP_Optout
and are stored in a new database table
wp_bp_optouts. This commit adds the following capabilities:

• Add new class BP_Optout.
• Add new table wp_bp_optouts.
• Create new table on installation or upgrade.
• Add convenience functions for adding, fetching or

deleting opt-outs.

• Add tests for basic opt-out management.

See #8448.

File:

• trunk/src/bp-core/admin/bp-core-admin-schema.php (modified) (2 diffs)

trunk/src/bp-core/admin/bp-core-admin-schema.php

@@ -40 +40 @@
     // Install the invitations table.
     bp_core_install_invitations();
+
+    // Install the nonmember opt-outs table.
+    bp_core_install_nonmember_opt_outs();
 
     // Notifications.
@@ -591 +594 @@
     do_action( 'bp_core_install_invitations' );
 }
+
+/**
+ * Install database tables to store opt-out requests from nonmembers.
+ *
+ * @since 8.0.0
+ *
+ * @uses bp_core_set_charset()
+ * @uses bp_core_get_table_prefix()
+ * @uses dbDelta()
+ */
+function bp_core_install_nonmember_opt_outs() {
+    $sql             = array();
+    $charset_collate = $GLOBALS['wpdb']->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' );
+}