Deprecation notices: declare the constant if thrown

... to prevent there ever being more than one deprecation notice in one page load.
WordPress · Sep 17, 2021 · 4e618f6 · 4e618f6
1 parent 84efc00
commit 4e618f6
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 39 deletions.
diff --git a/library/Deprecated.php b/library/Deprecated.php
@@ -25,6 +25,11 @@
 		. ' Switch to the PSR-4 `WpOrg\Requests\...` class names at your earliest convenience.',
 		E_USER_DEPRECATED
 	);
+
+	// Prevent the deprecation notice from being thrown twice.
+	if (!defined('REQUESTS_SILENCE_PSR0_DEPRECATIONS')) {
+		define('REQUESTS_SILENCE_PSR0_DEPRECATIONS', true);
+	}
 }
 
 if (interface_exists('Requests_Auth') === false && interface_exists('WpOrg\Requests\Auth') === true) {

diff --git a/library/Requests.php b/library/Requests.php
@@ -23,6 +23,11 @@
 		. ' Switch to the PSR-4 `WpOrg\Requests\...` class names at your earliest convenience.',
 		E_USER_DEPRECATED
 	);
+
+	// Prevent the deprecation notice from being thrown twice.
+	if (!defined('REQUESTS_SILENCE_PSR0_DEPRECATIONS')) {
+		define('REQUESTS_SILENCE_PSR0_DEPRECATIONS', true);
+	}
 }
 
 require_once dirname(__DIR__) . '/src/Requests.php';

diff --git a/src/Autoload.php b/src/Autoload.php
@@ -95,20 +95,6 @@ class Autoload {
 			'requests_exception_http_unknown'            => '\WpOrg\Requests\Exception\Http\StatusUnknown',
 		);
 
-		/**
-		 * Whether or not a deprecation notice has been thrown for calling a deprecated class.
-		 *
-		 * @var bool
-		 */
-		private static $deprecation_thrown = false;
-
-		/**
-		 * Whether or not a deprecation notice should be thrown for calling a deprecated class.
-		 *
-		 * @var bool
-		 */
-		private static $throw_notice = true;
-
 		/**
 		 * Register the autoloader.
 		 *
@@ -146,12 +132,8 @@ public static function load($class_name) {
 			}
 
 			if ($class_name === 'Requests') {
-				/*
-				 * Reference to the original PSR-0 Requests class.
-				 * Loading this class will always generate a deprecation notice.
-				 */
-				$file                     = dirname(__DIR__) . '/library/Requests.php';
-				self::$deprecation_thrown = true;
+				// Reference to the original PSR-0 Requests class.
+				$file = dirname(__DIR__) . '/library/Requests.php';
 			} elseif ($psr_4_prefix_pos === 0) {
 				// PSR-4 classname.
 				$file = __DIR__ . '/' . strtr(substr($class_name, 15), '\\', '/') . '.php';
@@ -170,25 +152,23 @@ public static function load($class_name) {
 			$class_lower = strtolower($class_name);
 
 			if (isset(self::$deprecated_classes[$class_lower])) {
-				if (self::$throw_notice === true) {
-					/*
-					 * Integrators who cannot yet upgrade to the PSR-4 class names can silence deprecations
-					 * by defining a `REQUESTS_SILENCE_PSR0_DEPRECATIONS` constant and setting it to `true`.
-					 * The constant needs to be defined before the first deprecated class is requested
-					 * via this autoloader.
-					 */
-					if (defined('REQUESTS_SILENCE_PSR0_DEPRECATIONS') && REQUESTS_SILENCE_PSR0_DEPRECATIONS === true) {
-						self::$throw_notice = false;
-					}
-
-					if (self::$throw_notice === true && self::$deprecation_thrown === false) {
-						// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error
-						trigger_error(
-							'The PSR-0 `Requests_...` class names in the Request library are deprecated.'
-							. ' Switch to the PSR-4 `WpOrg\Requests\...` class names at your earliest convenience.',
-							E_USER_DEPRECATED
-						);
-						self::$deprecation_thrown = true;
+				/*
+				 * Integrators who cannot yet upgrade to the PSR-4 class names can silence deprecations
+				 * by defining a `REQUESTS_SILENCE_PSR0_DEPRECATIONS` constant and setting it to `true`.
+				 * The constant needs to be defined before the first deprecated class is requested
+				 * via this autoloader.
+				 */
+				if (!defined('REQUESTS_SILENCE_PSR0_DEPRECATIONS') || REQUESTS_SILENCE_PSR0_DEPRECATIONS !== true) {
+					// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error
+					trigger_error(
+						'The PSR-0 `Requests_...` class names in the Request library are deprecated.'
+						. ' Switch to the PSR-4 `WpOrg\Requests\...` class names at your earliest convenience.',
+						E_USER_DEPRECATED
+					);
+
+					// Prevent the deprecation notice from being thrown twice.
+					if (!defined('REQUESTS_SILENCE_PSR0_DEPRECATIONS')) {
+						define('REQUESTS_SILENCE_PSR0_DEPRECATIONS', true);
 					}
 				}