WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
08/04/2022 02:50:27 PM (3 years ago)
Author:
johnbillion
Message:

Docs: Various corrections and improvements to inline documentation.

See #55646

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/option.php

    r53704 r53827  
    115115     * The dynamic portion of the hook name, `$option`, refers to the option name.
    116116     *
    117      * Returning a truthy value from the filter will effectively short-circuit retrieval
    118      * and return the passed value instead.
     117     * Returning a value other than false from the filter will short-circuit retrieval
     118     * and return that value instead.
    119119     *
    120120     * @since 1.5.0
    … …  
    833833     * The dynamic portion of the hook name, `$transient`, refers to the transient name.
    834834     *
    835      * Returning a truthy value from the filter will effectively short-circuit retrieval
    836      * and return the passed value instead.
     835     * Returning a value other than false from the filter will short-circuit retrieval
     836     * and return that value instead.
    837837     *
    838838     * @since 2.8.0
    … …  
    10041004/**
    10051005 * Deletes all expired transients.
     1006 *
     1007 * Note that this function won't do anything if an external object cache is in use.
    10061008 *
    10071009 * The multi-table delete syntax is used to delete the transient record
    … …  
    11331135 * Adds or updates user interface setting.
    11341136 *
    1135  * Both $name and $value can contain only ASCII letters, numbers, hyphens, and underscores.
    1136  *
    1137  * This function has to be used before any output has started as it calls setcookie().
     1137 * Both `$name` and `$value` can contain only ASCII letters, numbers, hyphens, and underscores.
     1138 *
     1139 * This function has to be used before any output has started as it calls `setcookie()`.
    11381140 *
    11391141 * @since 2.8.0
    … …  
    11601162 * Deleting settings would reset them to the defaults.
    11611163 *
    1162  * This function has to be used before any output has started as it calls setcookie().
     1164 * This function has to be used before any output has started as it calls `setcookie()`.
    11631165 *
    11641166 * @since 2.7.0
    … …  
    13901392     * The dynamic portion of the hook name, `$option`, refers to the option name.
    13911393     *
    1392      * Returning a truthy value from the filter will effectively short-circuit retrieval
    1393      * and return the passed value instead.
     1394     * Returning a value other than false from the filter will short-circuit retrieval
     1395     * and return that value instead.
    13941396     *
    13951397     * @since 2.9.0 As 'pre_site_option_' . $key
    … …  
    14211423
    14221424        /**
    1423          * Filters a specific default network option.
     1425         * Filters the value of a specific default network option.
    14241426         *
    14251427         * The dynamic portion of the hook name, `$option`, refers to the option name.
Note: See TracChangeset for help on using the changeset viewer.