Changeset 48185 for trunk/src/wp-admin/includes/misc.php

Timestamp:

06/26/2020 06:47:28 PM (5 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-admin/includes/misc.php (modified) (2 diffs)

trunk/src/wp-admin/includes/misc.php

@@ -696 +696 @@
                      * settings. See the parent function for a full list of standard options.
                      *
-                     * Returning false to the filter will skip saving the current option.
+                     * Returning false from the filter will skip saving the current option.
                      *
                      * @since 2.8.0
@@ -717 +717 @@
                  * The dynamic portion of the hook, `$option`, refers to the option name.
                  *
-                 * Returning false to the filter will skip saving the current option.
+                 * Returning false from the filter will skip saving the current option.
                  *
                  * @since 5.4.2