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 |
|---|---|
| 3168 | * |
| 3169 | * @since 2.8.0 |
| 3170 | * @since 4.1.0 Added `$user_login` and `$user_data` parameters. |
| 3171 | * |
| 3172 | * @param string $message Email message. |
| 3173 | * @param string $key The activation key. |
| 3174 | * @param string $user_login The username for the user. |
| 3175 | * @param WP_User $user_data WP_User object. |
| 3176 | */ |
| 3177 | $message = apply_filters( 'retrieve_password_message', $message, $key, $user_login, $user_data ); |
| 3178 | |
| 3179 | // Short-circuit on falsey $message value for backwards compatibility. |
| 3180 | if ( ! $message ) { |
| 3181 | return true; |
| 3182 | } |
| 3183 | |
| 3184 | /* |
| 3185 | * Wrap the single notification email arguments in an array |
| 3186 | * to pass them to the retrieve_password_notification_email filter. |