WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
07/27/2017 12:40:27 AM (9 years ago)
Author:
DrewAPicture
Message:

Docs: Remove @access notations from method DocBlocks in wp-includes/* classes.

Prior to about 2013, many class methods lacked even access modifiers which made the @access notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.

See #41452.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/class-wp-theme.php

    r40301 r41162  
    1313     *
    1414     * @since 4.4.0
    15      * @access public
    1615     * @var bool
    1716     *
    … …  
    2423     *
    2524     * @static
    26      * @access private
    2725     * @var array
    2826     */
    … …  
    4543     *
    4644     * @static
    47      * @access private
    4845     * @var array
    4946     */
    … …  
    6562     *
    6663     * @static
    67      * @access private
    6864     * @var array
    6965     */
    … …  
    7672     * Absolute path to the theme root, usually wp-content/themes
    7773     *
    78      * @access private
    7974     * @var string
    8075     */
    … …  
    8479     * Header data from the theme's style.css file.
    8580     *
    86      * @access private
    8781     * @var array
    8882     */
    … …  
    9286     * Header data from the theme's style.css file after being sanitized.
    9387     *
    94      * @access private
    9588     * @var array
    9689     */
    … …  
    10295     * Cached due to sorting functions running over the translated name.
    10396     *
    104      * @access private
    10597     * @var string
    10698     */
    … …  
    110102     * Errors encountered when initializing the theme.
    111103     *
    112      * @access private
    113104     * @var WP_Error
    114105     */
    … …  
    121112     * Otherwise, 'stylesheet' is the same as 'template'.
    122113     *
    123      * @access private
    124114     * @var string
    125115     */
    … …  
    132122     * Otherwise, 'template' is the same as 'stylesheet'.
    133123     *
    134      * @access private
    135124     * @var string
    136125     */
    … …  
    140129     * A reference to the parent theme, in the case of a child theme.
    141130     *
    142      * @access private
    143131     * @var WP_Theme
    144132     */
    … …  
    148136     * URL to the theme root, usually an absolute URL to wp-content/themes
    149137     *
    150      * @access private
    151138     * @var string
    152139     */
    … …  
    156143     * Flag for whether the theme's textdomain is loaded.
    157144     *
    158      * @access private
    159145     * @var bool
    160146     */
    … …  
    164150     * Stores an md5 hash of the theme root, to function as the cache key.
    165151     *
    166      * @access private
    167152     * @var string
    168153     */
    … …  
    175160     *
    176161     * @static
    177      * @access private
    178162     * @var bool
    179163     */
    … …  
    186170     *
    187171     * @static
    188      * @access private
    189172     * @var bool
    190173     */
    … …  
    512495     *
    513496     * @since 3.4.0
    514      * @access public
    515497     *
    516498     * @return WP_Error|false WP_Error if there are errors, or false.
    … …  
    527509     *
    528510     * @since 3.4.0
    529      * @access public
    530511     *
    531512     * @return bool Whether the theme exists.
    … …  
    539520     *
    540521     * @since 3.4.0
    541      * @access public
    542522     *
    543523     * @return WP_Theme|false Parent theme, or false if the current theme is not a child theme.
    … …  
    553533     *
    554534     * @since 3.4.0
    555      * @access private
    556535     *
    557536     * @param string $key Type of data to store (theme, screenshot, headers, post_templates)
    … …  
    569548     *
    570549     * @since 3.4.0
    571      * @access private
    572550     *
    573551     * @param string $key Type of data to retrieve (theme, screenshot, headers, post_templates)
    … …  
    582560     *
    583561     * @since 3.4.0
    584      * @access public
    585562     */
    586563    public function cache_delete() {
    … …  
    604581     *
    605582     * @since 3.4.0
    606      * @access public
    607583     *
    608584     * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
    … …  
    638614     *
    639615     * @since 3.4.0
    640      * @access public
    641616     *
    642617     * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
    … …  
    667642     *
    668643     * @since 3.4.0
    669      * @access private
    670644     *
    671645     * @staticvar array $header_tags
    … …  
    726700     *
    727701     * @since 3.4.0
    728      * @access private
    729702     *
    730703     * @staticvar string $comma
    … …  
    773746     *
    774747     * @since 3.4.0
    775      * @access private
    776748     *
    777749     * @staticvar array $tags_list
    … …  
    837809     *
    838810     * @since 3.4.0
    839      * @access public
    840811     *
    841812     * @return string Stylesheet
    … …  
    852823     *
    853824     * @since 3.4.0
    854      * @access public
    855825     *
    856826     * @return string Template
    … …  
    867837     *
    868838     * @since 3.4.0
    869      * @access public
    870839     *
    871840     * @return string Absolute path of the stylesheet directory.
    … …  
    885854     *
    886855     * @since 3.4.0
    887      * @access public
    888856     *
    889857     * @return string Absolute path of the template directory.
    … …  
    905873     *
    906874     * @since 3.4.0
    907      * @access public
    908875     *
    909876     * @return string URL to the stylesheet directory.
    … …  
    920887     *
    921888     * @since 3.4.0
    922      * @access public
    923889     *
    924890     * @return string URL to the template directory.
    … …  
    939905     *
    940906     * @since 3.4.0
    941      * @access public
    942907     *
    943908     * @return string Theme root.
    … …  
    955920     *
    956921     * @since 3.4.0
    957      * @access public
    958922     *
    959923     * @return string Theme root URI.
    … …  
    974938     *
    975939     * @since 3.4.0
    976      * @access public
    977940     *
    978941     * @param string $uri Type of URL to return, either 'relative' or an absolute URI. Defaults to absolute URI.
    … …  
    1006969     *
    1007970     * @since 3.4.0
    1008      * @access public
    1009971     *
    1010972     * @param mixed $type Optional. Array of extensions to return. Defaults to all files (null).
    … …  
    1027989     *
    1028990     * @since 4.7.0
    1029      * @access public
    1030991     *
    1031992     * @return array Array of page templates, keyed by filename and post type,
    … …  
    10841045     * @since 3.4.0
    10851046     * @since 4.7.0 Added the `$post_type` parameter.
    1086      * @access public
    10871047     *
    10881048     * @param WP_Post|null $post      Optional. The post being edited, provided for context.
    … …  
    11271087     *
    11281088     * @static
    1129      * @access private
    11301089     *
    11311090     * @param string            $path          Absolute path to search.
    … …  
    11891148     *
    11901149     * @since 3.4.0
    1191      * @access public
    11921150     *
    11931151     * @return bool True if the textdomain was successfully loaded or has already been loaded.
    … …  
    12231181     *
    12241182     * @since 3.4.0
    1225      * @access public
    12261183     *
    12271184     * @param string $check Optional. Whether to check only the 'network'-wide settings, the 'site'
    … …  
    12741231     *
    12751232     * @static
    1276      * @access public
    12771233     *
    12781234     * @param int $blog_id Optional. ID of the site. Defaults to the current site.
    … …  
    13011257     *
    13021258     * @static
    1303      * @access public
    13041259     *
    13051260     * @staticvar array $allowed_themes
    … …  
    13311286     *
    13321287     * @static
    1333      * @access public
    13341288     *
    13351289     * @staticvar array $allowed_themes
    … …  
    14101364     *
    14111365     * @since 4.6.0
    1412      * @access public
    14131366     * @static
    14141367     *
    … …  
    14361389     *
    14371390     * @since 4.6.0
    1438      * @access public
    14391391     * @static
    14401392     *
    … …  
    14661418     *
    14671419     * @static
    1468      * @access public
    14691420     *
    14701421     * @param array $themes Array of themes to sort, passed by reference.
    … …  
    14871438     *
    14881439     * @static
    1489      * @access private
    14901440     *
    14911441     * @param string $a First name.
    … …  
    15041454     *
    15051455     * @static
    1506      * @access private
    15071456     *
    15081457     * @param string $a First name.
Note: See TracChangeset for help on using the changeset viewer.