bp_core_replace_tokens_in_text( string $text, array $tokens )
Replace all tokens in the input text with appropriate values.
Description Description
Intended for use with the email system introduced in BuddyPress 2.5.0.
Parameters Parameters
- $text
-
(Required) Text to replace tokens in.
- $tokens
-
(Required) Token names and replacement values for the $text.
Return Return
(string)
Source Source
File: bp-core/bp-core-functions.php
function bp_core_replace_tokens_in_text( $text, $tokens ) { $unescaped = array(); $escaped = array(); foreach ( $tokens as $token => $value ) { if ( ! is_string( $value ) && 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 ); }
Changelog Changelog
Version | Description |
---|---|
2.5.0 | Introduced. |