WP hooks navigation: Home/browse • Actions index • Filters index
To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).
The best way to understand what a hook does is to look at where it occurs in the source code.
do_action( "hook_name" )apply_filters( "hook_name", "what_to_filter" ).Remember, this hook may occur in more than one file. Moreover, the hook's context may change from version to version.
| Line | Code |
|---|---|
| 3189 | * |
| 3190 | * @since 2.8.0 |
| 3191 | * @since 4.1.0 Added `$user_login` and `$user_data` parameters. |
| 3192 | * |
| 3193 | * @param string $message Email message. |
| 3194 | * @param string $key The activation key. |
| 3195 | * @param string $user_login The username for the user. |
| 3196 | * @param WP_User $user_data WP_User object. |
| 3197 | */ |
| 3198 | $message = apply_filters( 'retrieve_password_message', $message, $key, $user_login, $user_data ); |
| 3199 | |
| 3200 | // Short-circuit on falsey $message value for backwards compatibility. |
| 3201 | if ( ! $message ) { |
| 3202 | return true; |
| 3203 | } |
| 3204 | |
| 3205 | /* |
| 3206 | * Wrap the single notification email arguments in an array |
| 3207 | * to pass them to the retrieve_password_notification_email filter. |