wp_staticize_emoji_for_email( array $mail ): array

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$mailarray

The email data array.

Return value

array

The email data array, with emoji in the message staticized.

Performance profile

How much work a call to wp_staticize_emoji_for_email() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

4–72

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 77.

Plugin surface

1 hook

Third-party callbacks on 'wp_mail_content_type' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 13 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_staticize_emoji_for_email() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wp_staticize_emoji_for_email() runs, in this order:

1. 1
   apply_filters( wp_mail_content_type )filterline 6146 (+50 into the body)

   Filters the wp_mail() content type.

Uses · 3

• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_staticize_emoji()Converts emoji to a static img element.

Source code

View on Trac ↗View on GitHub ↗

6096function wp_staticize_emoji_for_email( $mail ) {6097	if ( ! isset( $mail['message'] ) ) {6098		return $mail;6099	}6100 6101	/*6102	 * We can only transform the emoji into images if it's a `text/html` email.6103	 * To do that, here's a cut down version of the same process that happens6104	 * in wp_mail() - get the `Content-Type` from the headers, if there is one,6105	 * then pass it through the {@see 'wp_mail_content_type'} filter, in case6106	 * a plugin is handling changing the `Content-Type`.6107	 */6108	$headers = array();6109	if ( isset( $mail['headers'] ) ) {6110		if ( is_array( $mail['headers'] ) ) {6111			$headers = $mail['headers'];6112		} else {6113			$headers = explode( "\n", str_replace( "\r\n", "\n", $mail['headers'] ) );6114		}6115	}6116 6117	foreach ( $headers as $header ) {6118		if ( ! str_contains( $header, ':' ) ) {6119			continue;6120		}6121 6122		// Explode them out.6123		list( $name, $content ) = explode( ':', trim( $header ), 2 );6124 6125		// Cleanup crew.6126		$name    = trim( $name );6127		$content = trim( $content );6128 6129		if ( 'content-type' === strtolower( $name ) ) {6130			if ( str_contains( $content, ';' ) ) {6131				list( $type, $charset ) = explode( ';', $content );6132				$content_type           = trim( $type );6133			} else {6134				$content_type = trim( $content );6135			}6136			break;6137		}6138	}6139 6140	// Set Content-Type if we don't have a content-type from the input headers.6141	if ( ! isset( $content_type ) ) {6142		$content_type = 'text/plain';6143	}6144 6145	/** This filter is documented in wp-includes/pluggable.php */6146	$content_type = apply_filters( 'wp_mail_content_type', $content_type );6147 6148	if ( 'text/html' === $content_type ) {6149		$mail['message'] = wp_staticize_emoji( $mail['message'] );6150	}6151 6152	return $mail;6153}

Changelog

Introduced in 4.2.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/formatting.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.