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

trunk/src/wp-includes/nav-menu-template.php

@@ -90 +90 @@
      * Filters whether to short-circuit the wp_nav_menu() output.
      *
-     * Passing a non-null value to the filter will short-circuit
-     * wp_nav_menu(), echoing that value if $args->echo is true,
-     * returning that value otherwise.
+     * Returning a non-null value from the filter will short-circuit wp_nav_menu(),
+     * echoing that value if $args->echo is true, returning that value otherwise.
      *
      * @since 3.9.0