Make WordPress Core


Ignore:
Timestamp:
07/23/2020 09:09:04 PM (5 years ago)
Author:
johnbillion
Message:

Docs: Another pass at some inline docs fixes mostly made by PHPCBF.

See #49572, #50744

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/option.php

    r48575 r48590  
    504504 * @global wpdb $wpdb WordPress database abstraction object.
    505505 *
    506  * @param string         $option      Name of the option to add. Expected to not be SQL-escaped.
    507  * @param mixed          $value       Optional. Option value. Must be serializable if non-scalar.
    508  *                                    Expected to not be SQL-escaped.
    509  * @param string         $deprecated Optional. Description. Not used anymore.
    510  * @param string|bool    $autoload    Optional. Whether to load the option when WordPress starts up.
    511  *                                    Default is enabled. Accepts 'no' to disable for legacy reasons.
     506 * @param string      $option     Name of the option to add. Expected to not be SQL-escaped.
     507 * @param mixed       $value      Optional. Option value. Must be serializable if non-scalar.
     508 *                                Expected to not be SQL-escaped.
     509 * @param string      $deprecated Optional. Description. Not used anymore.
     510 * @param string|bool $autoload   Optional. Whether to load the option when WordPress starts up.
     511 *                                Default is enabled. Accepts 'no' to disable for legacy reasons.
    512512 * @return bool True if the option was added, false otherwise.
    513513 */
     
    13041304 * @global wpdb $wpdb WordPress database abstraction object.
    13051305 *
    1306  * @param int      $network_id ID of the network. Can be null to default to the current network ID.
    1307  * @param string   $option     Name of the option to retrieve. Expected to not be SQL-escaped.
    1308  * @param mixed    $default    Optional. Value to return if the option doesn't exist. Default false.
     1306 * @param int    $network_id ID of the network. Can be null to default to the current network ID.
     1307 * @param string $option     Name of the option to retrieve. Expected to not be SQL-escaped.
     1308 * @param mixed  $default    Optional. Value to return if the option doesn't exist. Default false.
    13091309 * @return mixed Value set for the option.
    13101310 */
     
    16561656 * @global wpdb $wpdb WordPress database abstraction object.
    16571657 *
    1658  * @param int      $network_id ID of the network. Can be null to default to the current network ID.
    1659  * @param string   $option     Name of the option. Expected to not be SQL-escaped.
    1660  * @param mixed    $value      Option value. Expected to not be SQL-escaped.
     1658 * @param int    $network_id ID of the network. Can be null to default to the current network ID.
     1659 * @param string $option     Name of the option. Expected to not be SQL-escaped.
     1660 * @param mixed  $value      Option value. Expected to not be SQL-escaped.
    16611661 * @return bool True if the value was updated, false otherwise.
    16621662 */
     
    24342434 * @since 4.7.0
    24352435 *
    2436  * @param mixed $default Existing default value to return.
    2437  * @param string $option Option name.
    2438  * @param bool $passed_default Was `get_option()` passed a default value?
     2436 * @param mixed  $default        Existing default value to return.
     2437 * @param string $option         Option name.
     2438 * @param bool   $passed_default Was `get_option()` passed a default value?
    24392439 * @return mixed Filtered default value.
    24402440 */
Note: See TracChangeset for help on using the changeset viewer.