云策 WordPress 开发者社区

钩子文档

wp_mail_embed_args

查看官方原文 ↗
💡 云策文档标注

概述

wp_mail_embed_args 是一个 WordPress 过滤器，用于修改 PHPMailer 的 addEmbeddedImage() 方法的参数数组。它允许开发者在嵌入邮件图片时自定义路径、CID、名称、编码、类型和处置方式等属性。

关键要点

  • 过滤器名称：wp_mail_embed_args
  • 作用：过滤 addEmbeddedImage() 方法的参数数组
  • 参数数组包括：path（文件路径）、cid（Content-ID，默认为 embeds 数组的键）、name（文件名）、encoding（编码，默认为 'base64'）、type（MIME 类型，默认为空字符串以自动检测）、disposition（处置方式，默认为 'inline'）
  • 引入版本：WordPress 6.9.0

代码示例

$embed_args = apply_filters(
    'wp_mail_embed_args',
    array(
        'path'        => $embed_path,
        'cid'         => (string) $key,
        'name'        => basename( $embed_path ),
        'encoding'    => 'base64',
        'type'        => '',
        'disposition' => 'inline',
    )
);
📄 原文内容

Filters the arguments for PHPMailer’s addEmbeddedImage() method.

Parameters

$argsarray
An array of arguments for addEmbeddedImage().

  • path string
    The path to the file.
  • cid string
    The Content-ID of the image. Default: The key in the embeds array.
  • name string
    The filename of the image.
  • encoding string
    The encoding of the image. Default: 'base64'.
  • type string
    The MIME type of the image. Default: empty string, which lets PHPMailer auto-detect.
  • disposition string
    The disposition of the image. Default: 'inline'.

Source

$embed_args = apply_filters(
	'wp_mail_embed_args',
	array(
		'path'        => $embed_path,
		'cid'         => (string) $key,
		'name'        => basename( $embed_path ),
		'encoding'    => 'base64',
		'type'        => '',
		'disposition' => 'inline',
	)
);

View all references View on Trac View on GitHub

Used by Description
wp_mail()wp-includes/pluggable.php

Sends an email, similar to PHP’s mail function.

Changelog

Version Description
6.9.0 Introduced.