Changeset 48909

Timestamp:

08/31/2020 01:18:39 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Clarify the usage of null for auto_update_{$type} filter.

The value is internally used to detect whether nothing has hooked into this filter.

Props audrasjb, pbiron, johnbillion, SergeyBiryukov.
Fixes #50848.

File:

• trunk/src/wp-admin/includes/class-wp-automatic-updater.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-automatic-updater.php

@@ -196 +196 @@
                  *
                  * @since 3.7.0
-                 *
-                 * @param bool   $update Whether to update.
-                 * @param object $item   The update offer.
+                 * @since 5.5.0 The `$update` parameter accepts the value of null.
+                 *
+                 * @param bool|null $update Whether to update. The value of null is internally used
+                 *                          to detect whether nothing has hooked into this filter.
+                 * @param object    $item   The update offer.
                  */
                 $update = apply_filters( "auto_update_{$type}", $update, $item );