Source View: wp_mail_failed

To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).

Understanding Source Code

The best way to understand what a hook does is to look at where it occurs in the source code.

  • Action hooks look like this: do_action( "hook_name" )
  • Filter hooks look like this: 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.

Source View

This hook occurs 2 times in this file.

Line Code
357           $from_name = apply_filters( 'wp_mail_from_name', $from_name );
358
359           try {
360                $phpmailer->setFrom( $from_email, $from_name, false );
361           } catch ( phpmailerException $e ) {
362                $mail_error_data                             = compact( 'to', 'subject', 'message', 'headers', 'attachments' );
363                $mail_error_data['phpmailer_exception_code'] = $e->getCode();
364
365                /** This filter is documented in wp-includes/pluggable.php */
366                do_action( 'wp_mail_failed', new WP_Error( 'wp_mail_failed', $e->getMessage(), $mail_error_data ) );
367
368                return false;
369           }
370
371           // Set mail's subject and body
372           $phpmailer->Subject = $subject;
373           $phpmailer->Body    = $message;
374
375           // Set destination addresses, using appropriate methods for handling addresses
 
Line Code
493
494                /**
495                 * Fires after a phpmailerException is caught.
496                 *
497                 * @since 4.4.0
498                 *
499                 * @param WP_Error $error A WP_Error object with the phpmailerException message, and an array
500                 *                        containing the mail recipient, subject, message, headers, and attachments.
501                 */
502                do_action( 'wp_mail_failed', new WP_Error( 'wp_mail_failed', $e->getMessage(), $mail_error_data ) );
503
504                return false;
505           }
506      }
507 endif;
508
509 if ( ! function_exists( 'wp_authenticate' ) ) :
510      /**
511       * Authenticate a user, confirming the login credentials are valid.