WordPress.org

Make WordPress Core


Ignore:
Timestamp:
06/20/2020 12:38:55 PM (18 months ago)
Author:
SergeyBiryukov
Message:

Docs: Remove @staticvar tags from core.

The tag was supported in phpDocumentor 1.x, but is no longer supported in 2.x and 3.x.

Usage of static variables is considered an internal implementation detail and has no information value for someone reading the docs.

Props alishanvr, jrf.
Fixes #50426.

File:
1 edited

Legend:

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

    r48104 r48109  
    21262126 * @since 2.5.0
    21272127 *
    2128  * @staticvar string $temp
    2129  *
    21302128 * @return string Writable temporary directory.
    21312129 */
     
    22602258 * @since 2.0.0
    22612259 * @uses _wp_upload_dir()
    2262  *
    2263  * @staticvar array $cache
    2264  * @staticvar array $tested_paths
    22652260 *
    22662261 * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
     
    39863981 * @see _wp_json_sanity_check()
    39873982 *
    3988  * @staticvar bool $use_mb
    3989  *
    39903983 * @param string $string The string which is to be converted.
    39913984 * @return string The checked string.
     
    53505343 * @since 2.6.0
    53515344 *
    5352  * @staticvar bool $forced
    5353  *
    53545345 * @param string|bool $force Optional. Whether to force SSL in admin screens. Default null.
    53555346 * @return bool True if forced, false if not forced.
     
    54285419 * @since 3.3.0
    54295420 *
    5430  * @staticvar bool $_suspend
    5431  *
    54325421 * @param bool $suspend Optional. Suspends additions if true, re-enables them if false.
    54335422 * @return bool The current suspend setting
     
    55785567 *
    55795568 * @since 3.0.0
    5580  *
    5581  * @staticvar bool $global_terms
    55825569 *
    55835570 * @return bool True if multisite and global terms enabled.
     
    57195706 * @since 2.9.0
    57205707 * @since 4.7.0 Added the `$locale` parameter.
    5721  *
    5722  * @staticvar bool $mo_loaded
    5723  * @staticvar string $locale_loaded
    57245708 *
    57255709 * @param string $selected_zone Selected timezone.
     
    62596243 * @see esc_url()
    62606244 *
    6261  * @staticvar array $protocols
    6262  *
    62636245 * @return string[] Array of allowed protocols. Defaults to an array containing 'http', 'https',
    62646246 *                  'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet',
     
    62956277 *
    62966278 * @see https://core.trac.wordpress.org/ticket/19589
    6297  *
    6298  * @staticvar array $truncate_paths Array of paths to truncate.
    62996279 *
    63006280 * @param string $ignore_class Optional. A class to ignore all function calls within - useful
     
    66236603 *
    66246604 * @see reset_mbstring_encoding()
    6625  *
    6626  * @staticvar array $encodings
    6627  * @staticvar bool  $overloaded
    66286605 *
    66296606 * @param bool $reset Optional. Whether to reset the encoding back to a previously-set encoding.
     
    69636940 *
    69646941 * @since 5.0.3
    6965  *
    6966  * @staticvar int $id_counter
    69676942 *
    69686943 * @param string $prefix Prefix for the returned ID.
Note: See TracChangeset for help on using the changeset viewer.