IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: Standardize on "Returning a value from the filter" vs. "Passing a value to the filter".

Browse Source 
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.
Built from https://develop.svn.wordpress.org/trunk@48185


git-svn-id: http://core.svn.wordpress.org/trunk@47954 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov
2020-06-26 18:49:09 +00:00
parent eb9a6c9690
commit 40c389c95e
18 changed files with 44 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
wp-includes/option.php
View File

@@ -40,7 +40,7 @@ function get_option( $option, $default = false ) {
*
* The dynamic portion of the hook name, `$option`, refers to the option name.
*
* Passing a truthy value to the filter will short-circuit retrieving
* Returning a truthy value from the filter will short-circuit retrieving
* the option value, returning the passed value instead.
*
* @since 1.5.0
@@ -687,7 +687,7 @@ function get_transient( $transient ) {
*
* The dynamic portion of the hook name, `$transient`, refers to the transient name.
*
* Passing a truthy value to the filter will effectively short-circuit retrieval
* Returning a truthy value from the filter will effectively short-circuit retrieval
* of the transient, returning the passed value instead.
*
* @since 2.8.0
@@ -1237,8 +1237,8 @@ function get_network_option( $network_id, $option, $default = false ) {
*
* The dynamic portion of the hook name, `$option`, refers to the option name.
*
* Passing a truthy value to the filter will effectively short-circuit retrieval,
* returning the passed value instead.
* Returning a truthy value from the filter will effectively short-circuit retrieval
* and return the passed value instead.
*
* @since 2.9.0 As 'pre_site_option_' . $key
* @since 3.0.0
@@ -1750,8 +1750,8 @@ function get_site_transient( $transient ) {
*
* The dynamic portion of the hook name, `$transient`, refers to the transient name.
*
* Passing a truthy value to the filter will effectively short-circuit retrieval,
* returning the passed value instead.
* Returning a truthy value from the filter will effectively short-circuit retrieval
* and return the passed value instead.
*
* @since 2.9.0
* @since 4.4.0 The `$transient` parameter was added.