Skip to content

boolean_smtp_transport_settings_schema

Filters a transport's connection settings schema before the admin UI renders it.

filter Tier B Since 1.0.0

Applies to every transport after the plugin's own fields are in place. Add a field here to collect an extra setting on the connection form — the add-on adds the webhook secret of the providers that report delivery events this way. A field follows the schema shape (`type`, `label`, `required`, `default`, optional `help`, `options`, `visible_when`); its value is stored with the connection and, when its name matches a secret fragment or `boolean_smtp_sensitive_keys`, encrypted.

Signature

add_filter( 'boolean_smtp_transport_settings_schema', $callback, 10, 2 );

Parameters

ParameterTypeDescription
$schemaarray<string, array<string, mixed>>The settings schema, keyed by field name.
$driverstringTransport driver slug.

Returns array<string, array<string, mixed>> — The filtered schema.

Fires in

Example

boolean_smtp_transport_settings_schema.php
add_filter( 'boolean_smtp_transport_settings_schema', function ( array $schema, string $driver ) {
return $schema;
}, 10, 2 );

Next steps