Changeset 52244 for trunk/src/wp-includes/Requests/Hooks.php

Timestamp:

11/25/2021 01:10:30 AM (4 years ago)

Author:

SergeyBiryukov

Message:

External Libraries: Update the Requests library to version 2.0.0.

This is a major release and contains breaking changes.

Most important changes to be aware of for this release:

• All code is now namespaced. Though there is a full backward compatibility layer available and the old class names are still supported, using them will generate a deprecation notice (which can be silenced by plugins if they'd need to support multiple WP versions). See the ​upgrade guide for more details.
• A lot of classes have been marked final. This should generally not affect userland code as care has been taken to not apply the final keyword to classes which are known to be extended in userland code.
• Extensive input validation has been added to Requests. When Requests is used as documented though, this will be unnoticable.
• A new WpOrg\Requests\Requests::has_capabilities() method has been introduced which can be used to address #37708.
• A new WpOrg\Requests\Response::decode_body() method has been introduced which may be usable to simplify some of the WP native wrapper code.
• Remaining PHP 8.0 compatibility fixed (support for named parameters).
• PHP 8.1 compatibility.

Release notes: ​https://github.com/WordPress/Requests/releases/tag/v2.0.0

For a full list of changes in this update, see the Requests GitHub:
​https://github.com/WordPress/Requests/compare/v1.8.1...v2.0.0

Follow-up to [50842], [51078].

Props jrf, schlessera, datagutten, wojsmol, dd32, dustinrue, soulseekah, costdev, szepeviktor.
Fixes #54504.

File:

• trunk/src/wp-includes/Requests/Hooks.php (modified) (4 diffs)

trunk/src/wp-includes/Requests/Hooks.php

@@ -3 +3 @@
  * Handles adding and dispatching events
  *
- * @package Requests
- * @subpackage Utilities
+ * @package Requests\EventDispatcher
  */
+
+namespace WpOrg\Requests;
+
+use WpOrg\Requests\Exception\InvalidArgument;
+use WpOrg\Requests\HookManager;
+use WpOrg\Requests\Utility\InputValidator;
 
 /**
  * Handles adding and dispatching events
  *
- * @package Requests
- * @subpackage Utilities
+ * @package Requests\EventDispatcher
  */
-class Requests_Hooks implements Requests_Hooker {
+class Hooks implements HookManager {
     /**
      * Registered callbacks for each hook
@@ -19 +23 @@
      * @var array
      */
-    protected $hooks = array();
-
-    /**
-     * Constructor
-     */
-    public function __construct() {
-        // pass
-    }
+    protected $hooks = [];
 
     /**
@@ -32 +29 @@
      *
      * @param string $hook Hook name
-     * @param callback $callback Function/method to call on event
+     * @param callable $callback Function/method to call on event
      * @param int $priority Priority number. <0 is executed earlier, >0 is executed later
+     * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $hook argument is not a string.
+     * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $callback argument is not callable.
+     * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $priority argument is not an integer.
      */
     public function register($hook, $callback, $priority = 0) {
+        if (is_string($hook) === false) {
+            throw InvalidArgument::create(1, '$hook', 'string', gettype($hook));
+        }
+
+        if (is_callable($callback) === false) {
+            throw InvalidArgument::create(2, '$callback', 'callable', gettype($callback));
+        }
+
+        if (InputValidator::is_numeric_array_key($priority) === false) {
+            throw InvalidArgument::create(3, '$priority', 'integer', gettype($priority));
+        }
+
         if (!isset($this->hooks[$hook])) {
-            $this->hooks[$hook] = array();
-        }
-        if (!isset($this->hooks[$hook][$priority])) {
-            $this->hooks[$hook][$priority] = array();
+            $this->hooks[$hook] = [
+                $priority => [],
+            ];
+        } elseif (!isset($this->hooks[$hook][$priority])) {
+            $this->hooks[$hook][$priority] = [];
         }
 
@@ -52 +65 @@
      * @param array $parameters Parameters to pass to callbacks
      * @return boolean Successfulness
+     * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $hook argument is not a string.
+     * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $parameters argument is not an array.
      */
-    public function dispatch($hook, $parameters = array()) {
+    public function dispatch($hook, $parameters = []) {
+        if (is_string($hook) === false) {
+            throw InvalidArgument::create(1, '$hook', 'string', gettype($hook));
+        }
+
+        // Check strictly against array, as Array* objects don't work in combination with `call_user_func_array()`.
+        if (is_array($parameters) === false) {
+            throw InvalidArgument::create(2, '$parameters', 'array', gettype($parameters));
+        }
+
         if (empty($this->hooks[$hook])) {
             return false;
         }
 
+        if (!empty($parameters)) {
+            // Strip potential keys from the array to prevent them being interpreted as parameter names in PHP 8.0.
+            $parameters = array_values($parameters);
+        }
+
         foreach ($this->hooks[$hook] as $priority => $hooked) {
             foreach ($hooked as $callback) {
-                call_user_func_array($callback, $parameters);
+                $callback(...$parameters);
             }
         }