Changeset 10491

Timestamp:

02/01/2016 07:44:36 PM (9 years ago)

Author:

djpaul

Message:

Emails: move static token replacement function into its own function.

The token replacement, while intended for BP_Email, in theory could be used anywhere else, and having a common function would allow consistent filtering.
It also helps by reducing the amount of code in the BP_Email class, and therefore overall complexity.

See #6592

Location:

trunk/src/bp-core

Files:

• bp-core-functions.php (modified) (1 diff)
• classes/class-bp-email.php (modified) (2 diffs)

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

@@ -3048 +3048 @@
     ), $object );
 }
+
+/**
+ * Replace all tokens in the input text with appropriate values.
+ *
+ * Intended for use with the email system introduced in BuddyPress 2.5.0.
+ *
+ * @since 2.5.0
+ *
+ * @param string $text
+ * @param array $tokens Token names and replacement values for the $text.
+ * @return string
+ */
+function bp_core_replace_tokens_in_text( $text, $tokens ) {
+    $unescaped = array();
+    $escaped   = array();
+
+    foreach ( $tokens as $token => $value ) {
+        if ( is_callable( $value ) ) {
+            $value = call_user_func( $value );
+        }
+
+        // Tokens could be objects or arrays.
+        if ( ! is_scalar( $value ) ) {
+            continue;
+        }
+
+        $unescaped[ '{{{' . $token . '}}}' ] = $value;
+        $escaped[ '{{' . $token . '}}' ]     = esc_html( $value );
+    }
+
+    $text = strtr( $text, $unescaped );  // Do first.
+    $text = strtr( $text, $escaped );
+
+    /**
+     * Filters text that has had tokens replaced.
+     *
+     * @since 2.5.0
+     *
+     * @param string $text
+     * @param array $tokens Token names and replacement values for the $text.
+     */
+    return apply_filters( 'bp_core_replace_tokens_in_text', $text, $tokens );
+}

trunk/src/bp-core/classes/class-bp-email.php

@@ -244 +244 @@
 
             case 'replace-tokens':
-                $retval = self::replace_tokens( $retval, $this->get_tokens( 'raw' ) );
+                $retval = bp_core_replace_tokens_in_text( $retval, $this->get_tokens( 'raw' ) );
                 // Fall through.
 
@@ -949 +949 @@
         return apply_filters( 'bp_email_validate', $retval, $this );
     }
-
-
-    /*
-     * Utility functions.
-     *
-     * Unlike other methods in this class, utility functions are not chainable.
-     */
-
-    /**
-     * Replace all tokens in the input with appropriate values.
-     *
-     * Unlike most other methods in this class, this one is not chainable.
-     *
-     * @since 2.5.0
-     *
-     * @param string $text
-     * @param array $tokens Token names and replacement values for the $text.
-     * @return string
-     */
-    public static function replace_tokens( $text, $tokens ) {
-        $unescaped = array();
-        $escaped   = array();
-
-        foreach ( $tokens as $token => $value ) {
-            if ( is_callable( $value ) ) {
-                $value = call_user_func( $value );
-            }
-
-            // Some tokens are objects or arrays for backwards compatibilty. See bp_core_deprecated_email_filters().
-            if ( ! is_scalar( $value ) ) {
-                continue;
-            }
-
-            $unescaped[ '{{{' . $token . '}}}' ] = $value;
-            $escaped[ '{{' . $token . '}}' ]     = esc_html( $value );
-        }
-
-        $text = strtr( $text, $unescaped );  // Do first.
-        $text = strtr( $text, $escaped );
-
-        /**
-         * Filters text that has had tokens replaced.
-         *
-         * @since 2.5.0
-         *
-         * @param string $text
-         * @param array $tokens Token names and replacement values for the $text.
-         */
-        return apply_filters( 'bp_email_replace_tokens', $text, $tokens );
-    }
 }