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

Timestamp:

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

trunk/src/wp-includes/post.php

@@ -3686 +3686 @@
      * 2. The title, editor, and excerpt fields are all empty
      *
-     * Passing a truthy value to the filter will effectively short-circuit
-     * the new post being inserted, returning 0. If $wp_error is true, a WP_Error
+     * Returning a truthy value from the filter will effectively short-circuit
+     * the new post being inserted and return 0. If $wp_error is true, a WP_Error
      * will be returned instead.
      *