Changeset 48185 for trunk/src/wp-includes/functions.php

Timestamp:

06/26/2020 06:47:28 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Standardize on "Returning a value from the filter" vs. "Passing a value to the filter".

The filter is the callback function added with add_filter(), therefore the hook passes a value to the filter, and the filter returns a value to change its behaviour.

The documentation is referring to the latter.

Props johnbillion.
See #49572, #16557.

File:

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

trunk/src/wp-includes/functions.php

@@ -2655 +2655 @@
          * Filters whether to treat the upload bits as an error.
          *
-         * Returning a non-array from the filter will effectively short-circuit preparing the upload
-         * bits, returning that value instead. An error message should be returned as a string.
+         * Returning a non-array from the filter will effectively short-circuit preparing the upload bits
+         * and return that value instead. An error message should be returned as a string.
          *
          * @since 3.0.0
@@ -4579 +4579 @@
          * Filters whether to load the Widgets library.
          *
-         * Passing a falsey value to the filter will effectively short-circuit
+         * Returning a falsey value from the filter will effectively short-circuit
          * the Widgets library from loading.
          *
@@ -5581 +5581 @@
                  * Filters whether global terms are enabled.
                  *
-                 * Passing a non-null value to the filter will effectively short-circuit the function,
-                 * returning the value of the 'global_terms_enabled' site option instead.
+                 * Returning a non-null value from the filter will effectively short-circuit the function
+                 * and return the value of the 'global_terms_enabled' site option instead.
                  *
                  * @since 3.0.0
@@ -6449 +6449 @@
          * Filters whether to load the authentication check.
          *
-         * Passing a falsey value to the filter will effectively short-circuit
+         * Returning a falsey value from the filter will effectively short-circuit
          * loading the authentication check.
          *