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

Timestamp:

06/26/2020 06:47:28 PM (4 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/formatting.php (modified) (1 diff)

trunk/src/wp-includes/formatting.php

@@ -65 +65 @@
          * Filters whether to skip running wptexturize().
          *
-         * Passing false to the filter will effectively short-circuit wptexturize().
-         * returning the original text passed to the function instead.
+         * Returning false from the filter will effectively short-circuit wptexturize()
+         * and return the original text passed to the function instead.
          *
          * The filter runs only once, the first time wptexturize() is called.