Hooks and Filters¶

WP OTP exposes three filter hooks for customising the OTP email, and registers several WordPress hooks internally. This page documents both.

Outgoing filters (for plugin consumers)¶

These are filters the plugin applies via apply_filters(). Third-party code can hook into them to customise behaviour.

wp_otp_email_subject¶

Filters the email subject line.

Signature:

apply_filters( 'wp_otp_email_subject', string $subject, \WP_User $user ): string

Example — append the site tagline:

add_filter( 'wp_otp_email_subject', function ( string $subject, \WP_User $user ): string {
    return $subject . ' — ' . get_bloginfo( 'description' );
}, 10, 2 );

wp_otp_email_message¶

Filters the full email body.

Signature:

apply_filters( 'wp_otp_email_message', string $message, string $code, \WP_User $user ): string

Default message:

Sent as HTML. The header renders as a logo image when Settings → WP OTP → Email logo URL is set; otherwise it falls back to the site name as bold text. The site name is always read from Settings → General → Site Title (get_bloginfo('name')).

With logo:

<p style="margin:0 0 16px;">
  <img src="{logo_url}" alt="{site name}" style="max-height:{logo_height}px;display:block;">
</p>
<p style="margin:0;">Your {site name} login code is: <b>{code}</b>. This code expires in {duration} minutes.</p>

Without logo:

<p style="font-size:24px;font-weight:bold;margin:0 0 16px;">{site name}</p>
<p style="margin:0;">Your {site name} login code is: <b>{code}</b>. This code expires in {duration} minutes.</p>

Example — custom message:

add_filter( 'wp_otp_email_message', function ( string $message, string $code, \WP_User $user ): string {
    return sprintf(
        '<p>Hi %s,</p><p>Your login code is: <strong>%s</strong></p>',
        esc_html( $user->display_name ),
        esc_html( $code )
    );
}, 10, 3 );

wp_otp_email_headers¶

Filters the array of additional email headers passed to wp_mail().

Signature:

apply_filters( 'wp_otp_email_headers', string[] $headers, \WP_User $user ): string[]

Example — add a Reply-To header:

add_filter( 'wp_otp_email_headers', function ( array $headers, \WP_User $user ): array {
    $headers[] = 'Reply-To: noreply@example.com';
    return $headers;
}, 10, 2 );

Incoming hooks (registered by the plugin)¶

These are hooks the plugin registers internally via add_filter() / add_action(). They are listed here for completeness — third-party code should not need to remove or re-hook them.

WP Login flow (WpLoginProvider)¶

Admin settings page (Admin)¶

GraphQL layer (GraphQlProvider) — optional¶

WordPress core hooks used (read-only)¶

The plugin calls the following WordPress functions but does not register hooks for them: