From 391922e8b4d035a2f1ab49b6395acbae7c384081 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Fri, 25 Feb 2022 13:46:23 +0000 Subject: [PATCH] Code Modernization: Check the return type of `wp_parse_url()` in `wp_mail()`. As per the PHP manual: > If the `component` parameter is omitted, an associative array is returned. > If the `component` parameter is specified, `parse_url()` returns a string (or an int, in the case of `PHP_URL_PORT`) instead of an array. If the requested component doesn't exist within the given URL, `null` will be returned. Reference: [https://www.php.net/manual/en/function.parse-url.php#refsect1-function.parse-url-returnvalues PHP Manual: parse_url(): Return Values] In PHP 8.1, if the home URL does not have a "host" component, it would lead to a `substr(): Passing null to parameter #1 ($string) of type string is deprecated` notice. Changing the logic around and adding validation for the return type value of `wp_parse_url()` prevents that. Follow-up to [48601], [51606], [51622], [51626], [51629], [51630]. Props dennisatyoast, jrf. See #54730. git-svn-id: https://develop.svn.wordpress.org/trunk@52799 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/pluggable.php | 14 +++++++++----- tests/phpunit/tests/mail.php | 22 ++++++++++++++++++++++ 2 files changed, 31 insertions(+), 5 deletions(-) diff --git a/src/wp-includes/pluggable.php b/src/wp-includes/pluggable.php index ffcd2bdcc3..fdbfdea250 100644 --- a/src/wp-includes/pluggable.php +++ b/src/wp-includes/pluggable.php @@ -378,12 +378,16 @@ if ( ! function_exists( 'wp_mail' ) ) : */ if ( ! isset( $from_email ) ) { // Get the site domain and get rid of www. - $sitename = wp_parse_url( network_home_url(), PHP_URL_HOST ); - if ( 'www.' === substr( $sitename, 0, 4 ) ) { - $sitename = substr( $sitename, 4 ); - } + $sitename = wp_parse_url( network_home_url(), PHP_URL_HOST ); + $from_email = 'wordpress@'; - $from_email = 'wordpress@' . $sitename; + if ( null !== $sitename ) { + if ( 'www.' === substr( $sitename, 0, 4 ) ) { + $sitename = substr( $sitename, 4 ); + } + + $from_email .= $sitename; + } } /** diff --git a/tests/phpunit/tests/mail.php b/tests/phpunit/tests/mail.php index 66a613234b..8bf0a083c9 100644 --- a/tests/phpunit/tests/mail.php +++ b/tests/phpunit/tests/mail.php @@ -225,6 +225,28 @@ class Tests_Mail extends WP_UnitTestCase { $this->assertStringContainsString( $expected, $mailer->get_sent()->header ); } + /** + * Tests that wp_mail() returns false with an empty home URL and does not error out on PHP 8.1. + * + * @ticket 54730 + */ + public function test_wp_mail_with_empty_home_url() { + $to = 'address@tld.com'; + $subject = 'Testing'; + $message = 'Test Message'; + + // Multisite test runs. + add_filter( 'network_home_url', '__return_empty_string' ); + + // Single site test runs. + add_filter( 'home_url', '__return_empty_string' ); + + $success = wp_mail( $to, $subject, $message ); + + $this->assertFalse( $success, 'wp_mail() should have returned false' ); + $this->assertGreaterThan( 0, did_action( 'wp_mail_failed' ), 'wp_mail_failed action was not called' ); + } + /** * @ticket 30266 */