apply_filters( 'wp_mail_embed_args', array $args )

Compatibility

Present in 3 of the 5 tracked releases, added in 6.9.0.

Parameters

$argsarray

{ An array of arguments for PHPMailer's addEmbeddedImage() method.
@type string $path The path to the file.
@type string $cid The Content-ID of the image. Default: The key in the embeds array.
@type string $name The filename of the image.
@type string $encoding The encoding of the image. Default: 'base64'.
@type string $type The MIME type of the image. Default: empty string, which lets PHPMailer auto-detect.
@type string $disposition The disposition of the image. Default: 'inline'.
}

• $pathstring

  The path to the file.

• $cidstring

  The Content-ID of the image. Default: The key in the embeds array.

• $namestring

  The filename of the image.

• $encodingstring

  The encoding of the image. Default: 'base64'.

• $typestring

  The MIME type of the image. Default: empty string, which lets PHPMailer auto-detect.

• $dispositionstring

  The disposition of the image. Default: 'inline'.

Where this hook fires · 1

• wp-includes/pluggable.php:588wp_mail()

Source code

View on Trac ↗View on GitHub ↗

582				 *     @type string $name        The filename of the image.583				 *     @type string $encoding    The encoding of the image. Default: 'base64'.584				 *     @type string $type        The MIME type of the image. Default: empty string, which lets PHPMailer auto-detect.585				 *     @type string $disposition The disposition of the image. Default: 'inline'.586				 * }587				 */588				$embed_args = apply_filters(589					'wp_mail_embed_args',590					array(591						'path'        => $embed_path,592						'cid'         => (string) $key,593						'name'        => basename( $embed_path ),594						'encoding'    => 'base64',

Changelog

Introduced in 6.9.0. Unchanged from 6.9.7 through 7.1.0.

1. 6.9.7
2. 7.0.4
3. 7.1.0

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

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, 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.