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

trunk/src/wp-includes/link-template.php

@@ -3858 +3858 @@
      * Filters whether to preempt generating a shortlink for the given post.
      *
-     * Passing a truthy value to the filter will effectively short-circuit the
-     * shortlink-generation process, returning that value instead.
+     * Returning a truthy value from the filter will effectively short-circuit
+     * the shortlink generation process, returning that value instead.
      *
      * @since 3.0.0