Make WordPress Core

Ticket #11558: wp-includes-functions-phpdoc.diff

File wp-includes-functions-phpdoc.diff, 3.1 KB (added by miqrogroove, 15 years ago)

phpdoc for @since 2.8 and @since 2.9 in wp-admin/functions.php

  • functions.php

     
    31803180        return $current_suspend;
    31813181}
    31823182
     3183/**
     3184 * {@internal Missing Short Description}}
     3185 *
     3186 * @since 2.8
     3187 *
     3188 * @param unknown_type $key
     3189 * @param unknown_type $default
     3190 * @param unknown_type $use_cache
     3191 * @return unknown
     3192 */
    31833193function get_site_option( $key, $default = false, $use_cache = true ) {
    31843194        // Allow plugins to short-circuit site options.
    31853195        $pre = apply_filters( 'pre_site_option_' . $key, false );
     
    31913201        return apply_filters( 'site_option_' . $key, $value );
    31923202}
    31933203
    3194 // expects $key, $value not to be SQL escaped
     3204
     3205/**
     3206 * {@internal Missing Short Description}}
     3207 *
     3208 * @since 2.8
     3209 *
     3210 * @param unknown_type $key not to be SQL escaped
     3211 * @param unknown_type $value not to be SQL escaped
     3212 * @return unknown
     3213 */
    31953214function add_site_option( $key, $value ) {
    31963215        $value = apply_filters( 'pre_add_site_option_' . $key, $value );
    31973216        $result =  add_option($key, $value);
     
    31993218        return $result;
    32003219}
    32013220
     3221/**
     3222 * {@internal Missing Short Description}}
     3223 *
     3224 * @since 2.9
     3225 *
     3226 * @param unknown_type $key
     3227 * @return unknown
     3228 */
    32023229function delete_site_option( $key ) {
    32033230        $result = delete_option($key);
    32043231        do_action( "delete_site_option_{$key}", $key );
    32053232        return $result;
    32063233}
    32073234
    3208 // expects $key, $value not to be SQL escaped
     3235/**
     3236 * {@internal Missing Short Description}}
     3237 *
     3238 * @since 2.8
     3239 *
     3240 * @param unknown_type $key not to be SQL escaped
     3241 * @param unknown_type $value not to be SQL escaped
     3242 * @return unknown
     3243 */
    32093244function update_site_option( $key, $value ) {
    32103245        $oldvalue = get_site_option( $key );
    32113246        $value = apply_filters( 'pre_update_site_option_' . $key, $value, $oldvalue );
     
    32173252/**
    32183253 * Delete a site transient
    32193254 *
    3220  * @since 2.890
     3255 * @since 2.9
    32213256 * @package WordPress
    32223257 * @subpackage Transient
    32233258 *
     
    33123347 * gmt_offset modification for smart timezone handling
    33133348 *
    33143349 * Overrides the gmt_offset option if we have a timezone_string available
     3350 *
     3351 * @since 2.8
     3352 *
     3353 * @return unknown
    33153354 */
    33163355function wp_timezone_override_offset() {
    33173356        if ( !wp_timezone_supported() ) {
     
    33323371
    33333372/**
    33343373 * Check for PHP timezone support
     3374 *
     3375 * @since 2.9
     3376 *
     3377 * @return unknown
    33353378 */
    33363379function wp_timezone_supported() {
    33373380        $support = false;
     
    33463389        return apply_filters( 'timezone_support', $support );
    33473390}
    33483391
     3392/**
     3393 * {@internal Missing Short Description}}
     3394 *
     3395 * @since 2.9
     3396 *
     3397 * @param unknown_type $a
     3398 * @param unknown_type $b
     3399 * @return unknown
     3400 */
    33493401function _wp_timezone_choice_usort_callback( $a, $b ) {
    33503402        // Don't use translated versions of Etc
    33513403        if ( 'Etc' === $a['continent'] && 'Etc' === $b['continent'] ) {
     
    33873439/**
    33883440 * Gives a nicely formatted list of timezone strings // temporary! Not in final
    33893441 *
    3390  * @param $selected_zone string Selected Zone
     3442 * @since 2.9
    33913443 *
     3444 * @param string $selected_zone Selected Zone
     3445 * @return string
    33923446 */
    33933447function wp_timezone_choice( $selected_zone ) {
    33943448        static $mo_loaded = false;