WordPress.org

Make WordPress Core

Changeset 47347


Ignore:
Timestamp:
02/23/2020 01:05:28 AM (8 months ago)
Author:
SergeyBiryukov
Message:

Docs: Use third-person singular verbs for function descriptions in wp-includes/option.php, per the documentation standards.

See #48303.

File:
1 edited

Legend:

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

    r47325 r47347  
    154154
    155155/**
    156  * Protect WordPress special option from being modified.
     156 * Protects WordPress special option from being modified.
    157157 *
    158158 * Will die if $option is in protected list. Protected options are 'alloptions'
     
    176176
    177177/**
    178  * Print option value after sanitizing for forms.
     178 * Prints option value after sanitizing for forms.
    179179 *
    180180 * @since 1.5.0
     
    278278
    279279/**
    280  * Update the value of an option that was already added.
    281  *
    282  * You do not need to serialize values. If the value needs to be serialized, then
    283  * it will be serialized before it is inserted into the database. Remember,
    284  * resources can not be serialized or added as an option.
     280 * Updates the value of an option that was already added.
     281 *
     282 * You do not need to serialize values. If the value needs to be serialized,
     283 * then it will be serialized before it is inserted into the database.
     284 * Remember, resources cannot be serialized or added as an option.
    285285 *
    286286 * If the option does not exist, then the option will be added with the option value,
     
    438438
    439439/**
    440  * Add a new option.
    441  *
    442  * You do not need to serialize values. If the value needs to be serialized, then
    443  * it will be serialized before it is inserted into the database. Remember,
    444  * resources can not be serialized or added as an option.
     440 * Adds a new option.
     441 *
     442 * You do not need to serialize values. If the value needs to be serialized,
     443 * then it will be serialized before it is inserted into the database.
     444 * Remember, resources cannot be serialized or added as an option.
    445445 *
    446446 * You can create options without values and then update the values later.
     
    624624
    625625/**
    626  * Delete a transient.
     626 * Deletes a transient.
    627627 *
    628628 * @since 2.8.0
     
    671671
    672672/**
    673  * Get the value of a transient.
     673 * Retrieves the value of a transient.
    674674 *
    675675 * If the transient does not exist, does not have a value, or has expired,
     
    742742
    743743/**
    744  * Set/update the value of a transient.
    745  *
    746  * You do not need to serialize values. If the value needs to be serialized, then
    747  * it will be serialized before it is set.
     744 * Sets/updates the value of a transient.
     745 *
     746 * You do not need to serialize values. If the value needs to be serialized,
     747 * then it will be serialized before it is set.
    748748 *
    749749 * @since 2.8.0
     
    966966
    967967/**
    968  * Retrieve user interface setting value based on setting name.
     968 * Retrieves user interface setting value based on setting name.
    969969 *
    970970 * @since 2.7.0
     
    981981
    982982/**
    983  * Add or update user interface setting.
     983 * Adds or updates user interface setting.
    984984 *
    985985 * Both $name and $value can contain only ASCII letters, numbers, hyphens, and underscores.
     
    10051005
    10061006/**
    1007  * Delete user interface settings.
     1007 * Deletes user interface settings.
    10081008 *
    10091009 * Deleting settings would reset them to the defaults.
     
    10401040
    10411041/**
    1042  * Retrieve all user interface settings.
     1042 * Retrieves all user interface settings.
    10431043 *
    10441044 * @since 2.7.0
     
    10811081
    10821082/**
    1083  * Private. Set all user interface settings.
     1083 * Private. Sets all user interface settings.
    10841084 *
    10851085 * @since 2.8.0
     
    11241124
    11251125/**
    1126  * Delete the user settings of the current user.
     1126 * Deletes the user settings of the current user.
    11271127 *
    11281128 * @since 2.7.0
     
    11571157
    11581158/**
    1159  * Add a new option for the current network.
     1159 * Adds a new option for the current network.
    11601160 *
    11611161 * Existing options will not be updated. Note that prior to 3.3 this wasn't the case.
     
    11901190
    11911191/**
    1192  * Update the value of an option that was already added for the current network.
     1192 * Updates the value of an option that was already added for the current network.
    11931193 *
    11941194 * @since 2.8.0
     
    12061206
    12071207/**
    1208  * Retrieve a network's option value based on the option name.
     1208 * Retrieves a network's option value based on the option name.
    12091209 *
    12101210 * @since 4.4.0
     
    13371337
    13381338/**
    1339  * Add a new network option.
     1339 * Adds a new network option.
    13401340 *
    13411341 * Existing options will not be updated.
     
    15551555
    15561556/**
    1557  * Update the value of a network option that was already added.
     1557 * Updates the value of a network option that was already added.
    15581558 *
    15591559 * @since 4.4.0
     
    16861686
    16871687/**
    1688  * Delete a site transient.
     1688 * Deletes a site transient.
    16891689 *
    16901690 * @since 2.9.0
     
    17321732
    17331733/**
    1734  * Get the value of a site transient.
     1734 * Retrieves the value of a site transient.
    17351735 *
    17361736 * If the transient does not exist, does not have a value, or has expired,
     
    18041804
    18051805/**
    1806  * Set/update the value of a site transient.
    1807  *
    1808  * You do not need to serialize values, if the value needs to be serialize, then
    1809  * it will be serialized before it is set.
     1806 * Sets/updates the value of a site transient.
     1807 *
     1808 * You do not need to serialize values. If the value needs to be serialized,
     1809 * then it will be serialized before it is set.
    18101810 *
    18111811 * @since 2.9.0
     
    18971897
    18981898/**
    1899  * Register default settings available in WordPress.
     1899 * Registers default settings available in WordPress.
    19001900 *
    19011901 * The settings registered here are primarily useful for the REST API, so this
     
    20902090
    20912091/**
    2092  * Register a setting and its data.
     2092 * Registers a setting and its data.
    20932093 *
    20942094 * @since 2.7.0
     
    21932193
    21942194/**
    2195  * Unregister a setting.
     2195 * Unregisters a setting.
    21962196 *
    21972197 * @since 2.7.0
     
    22872287
    22882288/**
    2289  * Filter the default value for the option.
     2289 * Filters the default value for the option.
    22902290 *
    22912291 * For settings which register a default setting in `register_setting()`, this
Note: See TracChangeset for help on using the changeset viewer.