Changeset 12932 for trunk/src/bp-core/bp-core-template.php

Timestamp:

04/29/2021 01:28:50 PM (5 years ago)

Author:

imath

Message:

BP Email: introduce "unnamed" salutation

The member invites feature's goal is to invite external users to join a community. The BP Email feature uses a named salutation by default. As a result, the salutation of invitation emails was "Hi email@…,". The user's name is not yet known and using this kind of salutation is odd. The member invites feature's need is to simply use an "unnamed" salutation eg: "Hi,". To satisfy it we are updating the BP Email type schema with a new property $named_salutation which defaults to true. If this property is false, then the sent email will from now on use an unnamed salutation.

NB: to prevent potential back compatibiliy issues, each kind of salutation has their own filters

• Use bp_email_get_unnamed_salutation to edit the unnamed one.
• Use bp_email_get_salutation to edit the default one (named).

Props dcavins for coloring outside the lines a bit 😉

See #8139

File:

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

trunk/src/bp-core/bp-core-template.php

@@ -3801 +3801 @@
          *
          * @since 2.5.0
+         * @since 8.0.0 Checks current BP Email type schema to eventually use the unnamed salutation.
          *
          * @param array $settings Email Settings.
@@ -3806 +3807 @@
          */
         function bp_email_get_salutation( $settings = array() ) {
-                $token = '{{recipient.name}}';
-
-                /**
-                 * Filters The Recipient Salutation inside the Email Template.
-                 *
-                 * @since 2.5.0
-                 *
-                 * @param string $value    The Recipient Salutation.
-                 * @param array  $settings Email Settings.
-                 * @param string $token    The Recipient token.
-                 */
-                return apply_filters(
-                        'bp_email_get_salutation',
-                        sprintf(
-                                /* translators: %s: the email token for the recipient name */
-                                _x( 'Hi %s,', 'recipient salutation', 'buddypress' ),
+                $email_type = bp_email_get_type();
+                $saluation  = '';
+
+                if ( $email_type ) {
+                        $types_schema = bp_email_get_type_schema( 'named_salutation' );
+
+                        if ( isset( $types_schema[ $email_type ] ) && false === $types_schema[ $email_type ] ) {
+                                /**
+                                 * Filters The Recipient Unnamed Salutation inside the Email Template.
+                                 *
+                                 * @since 8.0.0
+                                 *
+                                 * @param string $value    The Recipient Salutation.
+                                 * @param array  $settings Email Settings.
+                                 */
+                                $saluation = apply_filters(
+                                        'bp_email_get_unnamed_salutation',
+                                        _x( 'Hi,', 'Unnamed recipient salutation', 'buddypress' ),
+                                        $settings
+                                );
+                        }
+                }
+
+                // Named salutations are default.
+                if ( ! $saluation ) {
+                        $token = '{{recipient.name}}';
+
+                        /**
+                         * Filters The Recipient Named Salutation inside the Email Template.
+                         *
+                         * @since 2.5.0
+                         *
+                         * @param string $value    The Recipient Salutation.
+                         * @param array  $settings Email Settings.
+                         * @param string $token    The Recipient token.
+                         */
+                        $saluation = apply_filters(
+                                'bp_email_get_salutation',
+                                sprintf(
+                                        /* translators: %s: the email token for the recipient name */
+                                        _x( 'Hi %s,', 'Named recipient salutation', 'buddypress' ),
+                                        $token
+                                ),
+                                $settings,
                                 $token
-                        ),
-                        $settings,
-                        $token
-                );
-        }
+                        );
+                }
+
+                return $saluation;
+        }