apply_filters( 'invited_user_email', array $new_user_email, int $user_id, array $role, string $newuser_key )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$new_user_emailarray

{ Used to build wp_mail().
@type string $to The email address of the invited user.
@type string $subject The subject of the email.
@type string $message The content of the email.
@type string $headers Headers.
}

• $tostring

  The email address of the invited user.

• $subjectstring

  The subject of the email.

• $messagestring

  The content of the email.

• $headersstring

  Headers.

$user_idint

The invited user's ID.

$rolearray

Array containing role information for the invited user.

$newuser_keystring

The key of the invitation.

Where this hook fires · 1

• wp-admin/user-new.php:170file scope

Source code

View on Trac ↗View on GitHub ↗

164<?php165			 * }166			 * @param int    $user_id     The invited user's ID.167			 * @param array  $role        Array containing role information for the invited user.168			 * @param string $newuser_key The key of the invitation.169			 *170			 */171			$new_user_email = apply_filters( 'invited_user_email', $new_user_email, $user_id, $role, $newuser_key );172 173			wp_mail(174				$new_user_email['to'],175				$new_user_email['subject'],176				$new_user_email['message'],177				$new_user_email['headers']

Changelog

Introduced in 5.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

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

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 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.