Ticket #7036: 7036.01.patch

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

@@ -531 +531 @@
  * Add default emails.
  *
  * @since 2.5.0
+ * @since 2.x.0 Added $email_types as a parameter.
+ *
+ * @param array $email_types Enter specific email types as an array to reinstall only those emails. If
+ *                           left empty, we will reinstall all email types.
  */
-function bp_core_install_emails() {
+function bp_core_install_emails( $email_types = array() ) {
         $defaults = array(
                 'post_status' => 'publish',
                 'post_type'   => bp_get_email_post_type(),
         );
 
-        $emails       = bp_email_get_schema();
-        $descriptions = bp_email_get_type_schema();
+        $emails       = bp_email_get_schema( $email_types );
+        $descriptions = bp_email_get_type_schema( $email_types );
 
         // Add these emails to the database.
         foreach ( $emails as $id => $email ) {
@@ -557 +561 @@
                 }
         }
 
-        /**
-         * Fires after BuddyPress adds the posts for its emails.
-         *
-         * @since 2.5.0
-         */
-        do_action( 'bp_core_install_emails' );
+        // Only fire hook when wiping out all BuddyPress emails.
+        if ( empty( $email_types ) ) {
+                /**
+                 * Fires after BuddyPress adds the posts for its emails.
+                 *
+                 * @since 2.5.0
+                 */
+                do_action( 'bp_core_install_emails' );
+        }
 }

src/bp-core/admin/bp-core-admin-tools.php

@@ -423 +423 @@
  * Delete emails and restore from defaults.
  *
  * @since 2.5.0
+ * @since 2.x.0 Added $email_types as a parameter.
  *
+ * @param array $email_types Enter specific email types as an array to reinstall only those emails. By
+ *                           default, we will reinstall all email types.
  * @return array
  */
-function bp_admin_reinstall_emails() {
+function bp_admin_reinstall_emails( $email_types = array() ) {
         $switched = false;
 
         // Switch to the root blog, where the email posts live.
@@ -437 +440 @@
                 $switched = true;
         }
 
-        $emails = get_posts( array(
+        $args = array(
                 'fields'           => 'ids',
                 'post_status'      => 'publish',
                 'post_type'        => bp_get_email_post_type(),
                 'posts_per_page'   => 200,
                 'suppress_filters' => false,
-        ) );
+        );
+
+        if ( ! empty( $email_types ) ) {
+                $args['tax_query'] = array(
+                        array(
+                                'taxonomy' => bp_get_email_tax_type(),
+                                'field'    => 'slug',
+                                'terms'    => $email_types,
+                        ),
+                );
+        }
+
+        $emails = get_posts( $args );
 
         if ( $emails ) {
                 foreach ( $emails as $email_id ) {
@@ -452 +467 @@
         }
 
         // Make sure we have no orphaned email type terms.
-        $email_types = get_terms( bp_get_email_tax_type(), array(
-                'fields'                 => 'ids',
-                'hide_empty'             => false,
-                'update_term_meta_cache' => false,
-        ) );
-
-        if ( $email_types ) {
-                foreach ( $email_types as $term_id ) {
-                        wp_delete_term( (int) $term_id, bp_get_email_tax_type() );
+        if ( empty( $email_types ) ) {
+                $remove_types = get_terms( bp_get_email_tax_type(), array(
+                        'fields'                 => 'ids',
+                        'hide_empty'             => false,
+                        'update_term_meta_cache' => false,
+                ) );
+
+                if ( $remove_types ) {
+                        foreach ( $remove_types as $term_id ) {
+                                wp_delete_term( (int) $term_id, bp_get_email_tax_type() );
+                        }
                 }
         }
 
         require_once( buddypress()->plugin_dir . '/bp-core/admin/bp-core-admin-schema.php' );
-        bp_core_install_emails();
+        bp_core_install_emails( $email_types );
 
         if ( $switched ) {
                 restore_current_blog();

src/bp-core/bp-core-functions.php

@@ -3115 +3115 @@
  * Get a list of emails for populating the email post type.
  *t
  * @since 2.5.1
+ * @since 2.x.0 Added $email_types as a parameter.
  *
+ * @param array $email_types Enter specific email types as an array to fetch data for only those emails.
+ *                           If left empty, we will fetch data for all email types.
  * @return array
  */
-function bp_email_get_schema() {
-        return array(
+function bp_email_get_schema( $email_types = array() ) {
+        $types = array(
                 'activity-comment' => array(
                         /* translators: do not remove {} brackets or translate its contents. */
                         'post_title'   => __( '[{{{site.name}}}] {{poster.name}} replied to one of your updates', 'buddypress' ),
@@ -3249 +3252 @@
                         'post_excerpt' => __( "Your membership request for the group "{{group.name}}" has been rejected.\n\nTo request membership again, visit: {{{group.url}}}", 'buddypress' ),
                 ),
         );
+
+        // Return data for specific email types.
+        if ( ! empty( $email_types ) ) {
+                return array_intersect_key( $types, array_flip( $email_types ) );
+        }
+
+        // Return all email types.
+        return $types;
 }
 
 /**
  * Get a list of emails for populating email type taxonomy terms.
  *
  * @since 2.5.1
+ * @since 2.x.0 Added $email_types as a parameter.
  *
+ * @param array $email_types Enter specific email types as an array to fetch data for only those emails.
+ *                           If left empty, we will fetch data for all email types.
  * @return array
  */
-function bp_email_get_type_schema() {
-        return array(
+function bp_email_get_type_schema( $email_types = array() ) {
+        $types = array(
                 'activity-comment'                   => __( 'A member has replied to an activity update that the recipient posted.', 'buddypress' ),
                 'activity-comment-author'            => __( 'A member has replied to a comment on an activity update that the recipient posted.', 'buddypress' ),
                 'activity-at-message'                => __( 'Recipient was mentioned in an activity update.', 'buddypress' ),
@@ -3277 +3291 @@
                 'groups-membership-request-accepted' => __( 'Recipient had requested to join a group, which was accepted.', 'buddypress' ),
                 'groups-membership-request-rejected' => __( 'Recipient had requested to join a group, which was rejected.', 'buddypress' ),
         );
+
+        // Return data for specific email types.
+        if ( ! empty( $email_types ) ) {
+                return array_intersect_key( $types, array_flip( $email_types ) );
+        }
+
+        // Return all email types.
+        return $types;
 }

tests/phpunit/testcases/admin/functions.php

@@ -221 +221 @@
 
         /**
          * @ticket BP6936
+         * @group emails
          */
         public function test_email_type_descriptions_should_match_when_split_terms_exist() {
                 global $wpdb;

tests/phpunit/testcases/core/class-bp-email.php

@@ -2 +2 @@
 /**
  * @group core
  * @group BP_Email
+ * @group emails
  */
 class BP_Tests_Email extends BP_UnitTestCase_Emails {
         protected $u1;
@@ -267 +268 @@
 
                 $this->assertTrue( $result );
         }
+
+        /**
+         * @group bp_admin_reinstall_emails
+         */
+        public function test_bp_admin_reinstall_emails_for_specific_email_types_only() {
+                // Fetch email post for an existing email type.
+                $settings_email = bp_get_email( 'settings-verify-email-change' );
+
+                // Fetch another email post just for comparison.
+                $activity_email = bp_get_email( 'activity-at-message' );
+
+                // Reinstall only the 'settings-verify-email-change' email.
+                require_once( buddypress()->plugin_dir . '/bp-core/admin/bp-core-admin-tools.php' );
+                bp_admin_reinstall_emails( array(
+                        'settings-verify-email-change'
+                ) );
+
+                // Refetch emails for comparison.
+                $new_settings_email = bp_get_email( 'settings-verify-email-change' );
+                $new_activity_email = bp_get_email( 'activity-at-message' );
+
+                // Assert!
+                $this->assertNotEquals( $settings_email->get_post_object(), $new_settings_email->get_post_object() );
+                $this->assertEquals( $activity_email->get_post_object(), $new_activity_email->get_post_object() );
+        }
 }