WordPress.org

Make WordPress Core


Ignore:
Timestamp:
05/26/2015 10:16:15 PM (5 years ago)
Author:
wonderboymusic
Message:

Fix doc blocks for option.php.

See #32444.

File:
1 edited

Legend:

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

    r32481 r32613  
    1919 * @since 1.5.0
    2020 *
    21  * @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
    22  * @param mixed $default Optional. Default value to return if the option does not exist.
     21 * @global wpdb $wpdb
     22 *
     23 * @param string $option  Name of option to retrieve. Expected to not be SQL-escaped.
     24 * @param mixed  $default Optional. Default value to return if the option does not exist.
    2325 * @return mixed Value set for the option.
    2426 */
     
    154156 * @since 2.2.0
    155157 *
     158 * @global wpdb $wpdb
     159 *
    156160 * @return array List of all options.
    157161 */
     
    185189 * @since 3.0.0
    186190 *
     191 * @global wpdb $wpdb
     192 *
    187193 * @param int $site_id Optional site ID for which to query the options. Defaults to the current site.
    188194 */
     
    222228 * @since 1.0.0
    223229 * @since 4.2.0 The `$autoload` parameter was added.
     230 *
     231 * @global wpdb $wpdb
    224232 *
    225233 * @param string      $option   Option name. Expected to not be SQL-escaped.
     
    363371 * @since 1.0.0
    364372 *
     373 * @global wpdb $wpdb
     374 *
    365375 * @param string         $option      Name of option to add. Expected to not be SQL-escaped.
    366376 * @param mixed          $value       Optional. Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
     
    457467 *
    458468 * @since 1.2.0
     469 *
     470 * @global wpdb $wpdb
    459471 *
    460472 * @param string $option Name of option to remove. Expected to not be SQL-escaped.
     
    779791 * @since 2.7.0
    780792 *
    781  * @param string $name The name of the setting.
     793 * @param string $name    The name of the setting.
    782794 * @param string $default Optional default value to return when $name is not set.
    783795 * @return mixed the last saved user setting or the default value/false if it doesn't exist.
     
    797809 * @since 2.8.0
    798810 *
    799  * @param string $name The name of the setting.
     811 * @param string $name  The name of the setting.
    800812 * @param string $value The value for the setting.
    801  * @return null|bool true if set successfully/false if not.
     813 * @return bool|void true if set successfully/false if not.
    802814 */
    803815function set_user_setting( $name, $value ) {
    804 
    805816    if ( headers_sent() ) {
    806817        return false;
     
    822833 *
    823834 * @param string $names The name or array of names of the setting to be deleted.
    824  * @return null|bool true if deleted successfully/false if not.
     835 * @return bool|void true if deleted successfully/false if not.
    825836 */
    826837function delete_user_setting( $names ) {
    827 
    828838    if ( headers_sent() ) {
    829839        return false;
     
    853863 * @since 2.7.0
    854864 *
     865 * @global array $_updated_user_settings
     866 *
    855867 * @return array the last saved user settings or empty array.
    856868 */
     
    891903 * @since 2.8.0
    892904 *
     905 * @global array $_updated_user_settings
     906 *
    893907 * @param array $user_settings
    894  * @return null|bool
     908 * @return bool|void
    895909 */
    896910function wp_set_all_user_settings( $user_settings ) {
     
    945959 * @see get_option()
    946960 *
    947  * @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
    948  * @param mixed $default Optional value to return if option doesn't exist. Default false.
    949  * @param bool $use_cache Whether to use cache. Multisite only. Default true.
     961 * @global wpdb $wpdb
     962 *
     963 * @param string $option    Name of option to retrieve. Expected to not be SQL-escaped.
     964 * @param mixed  $default   Optional value to return if option doesn't exist. Default false.
     965 * @param bool   $use_cache Whether to use cache. Multisite only. Default true.
    950966 * @return mixed Value set for the option.
    951967 */
     
    10401056 * @see add_option()
    10411057 *
     1058 * @global wpdb $wpdb
     1059 *
    10421060 * @param string $option Name of option to add. Expected to not be SQL-escaped.
    1043  * @param mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped.
     1061 * @param mixed  $value Optional. Option value, can be anything. Expected to not be SQL-escaped.
    10441062 * @return bool False if option was not added and true if option was added.
    10451063 */
     
    11281146 *
    11291147 * @see delete_option()
     1148 *
     1149 * @global wpdb $wpdb
    11301150 *
    11311151 * @param string $option Name of option to remove. Expected to not be SQL-escaped.
     
    11931213 * @see update_option()
    11941214 *
     1215 * @global wpdb $wpdb
     1216 *
    11951217 * @param string $option Name of option. Expected to not be SQL-escaped.
    1196  * @param mixed $value Option value. Expected to not be SQL-escaped.
     1218 * @param mixed  $value Option value. Expected to not be SQL-escaped.
    11971219 * @return bool False if value was not updated and true if value was updated.
    11981220 */
Note: See TracChangeset for help on using the changeset viewer.