Changeset 48185 for trunk/src/wp-includes/comment.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-includes/comment.php (modified) (1 diff)

trunk/src/wp-includes/comment.php

@@ -832 +832 @@
      *
      * @since 2.1.0
-     * @since 4.9.0 Returning a WP_Error value from the filter will shortcircuit comment insertion
+     * @since 4.9.0 Returning a WP_Error value from the filter will short-circuit comment insertion
      *              and allow skipping further processing.
      *