Skip to content

boolean_smtp_sensitive_keys

Filters the exact settings-key names whose values are encrypted at rest, masked in REST responses and redacted from logs.

filter Tier A Since 1.0.0

Keys containing `key`, `secret`, `password`, `token` or `username` are always secrets; a custom transport whose credential fields are named differently declares them here. The names returned are added to the built-in set: a listener can add keys, never make a built-in secret visible.

Signature

add_filter( 'boolean_smtp_sensitive_keys', $callback, 10, 1 );

Parameters

ParameterTypeDescription
$keyslist<string>Exact key names treated as secrets. Default `['webhook_url']`.

Returns list<string> — The key names to add to the built-in set.

Fires in

Example

boolean_smtp_sensitive_keys.php
add_filter( 'boolean_smtp_sensitive_keys', function ( array $keys ) {
return $keys;
}, 10, 1 );

Next steps