vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-28 14:20:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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.


git-svn-id: https://develop.svn.wordpress.org/trunk@41162 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes
2017-07-27 00:40:27 +00:00
parent 829139ba1a
commit b4d81bd654
135 changed files with 2 additions and 1906 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
src/wp-includes/class-wp-theme.php
View File

@@ -12,7 +12,6 @@ final class WP_Theme implements ArrayAccess {
* Whether the theme has been marked as updateable.
*
* @since 4.4.0
* @access public
* @var bool
*
* @see WP_MS_Themes_List_Table
@@ -23,7 +22,6 @@ final class WP_Theme implements ArrayAccess {
* Headers for style.css files.
*
* @static
* @access private
* @var array
*/
private static $file_headers = array(
@@ -44,7 +42,6 @@ final class WP_Theme implements ArrayAccess {
* Default themes.
*
* @static
* @access private
* @var array
*/
private static $default_themes = array(
@@ -64,7 +61,6 @@ final class WP_Theme implements ArrayAccess {
* Renamed theme tags.
*
* @static
* @access private
* @var array
*/
private static $tag_map = array(
@@ -75,7 +71,6 @@ final class WP_Theme implements ArrayAccess {
/**
* Absolute path to the theme root, usually wp-content/themes
*
* @access private
* @var string
*/
private $theme_root;
@@ -83,7 +78,6 @@ final class WP_Theme implements ArrayAccess {
/**
* Header data from the theme's style.css file.
*
* @access private
* @var array
*/
private $headers = array();
@@ -91,7 +85,6 @@ final class WP_Theme implements ArrayAccess {
/**
* Header data from the theme's style.css file after being sanitized.
*
* @access private
* @var array
*/
private $headers_sanitized;
@@ -101,7 +94,6 @@ final class WP_Theme implements ArrayAccess {
*
* Cached due to sorting functions running over the translated name.
*
* @access private
* @var string
*/
private $name_translated;
@@ -109,7 +101,6 @@ final class WP_Theme implements ArrayAccess {
/**
* Errors encountered when initializing the theme.
*
* @access private
* @var WP_Error
*/
private $errors;
@@ -120,7 +111,6 @@ final class WP_Theme implements ArrayAccess {
* In the case of a child theme, this is directory name of the child theme.
* Otherwise, 'stylesheet' is the same as 'template'.
*
* @access private
* @var string
*/
private $stylesheet;
@@ -131,7 +121,6 @@ final class WP_Theme implements ArrayAccess {
* In the case of a child theme, this is the directory name of the parent theme.
* Otherwise, 'template' is the same as 'stylesheet'.
*
* @access private
* @var string
*/
private $template;
@@ -139,7 +128,6 @@ final class WP_Theme implements ArrayAccess {
/**
* A reference to the parent theme, in the case of a child theme.
*
* @access private
* @var WP_Theme
*/
private $parent;
@@ -147,7 +135,6 @@ final class WP_Theme implements ArrayAccess {
/**
* URL to the theme root, usually an absolute URL to wp-content/themes
*
* @access private
* @var string
*/
private $theme_root_uri;
@@ -155,7 +142,6 @@ final class WP_Theme implements ArrayAccess {
/**
* Flag for whether the theme's textdomain is loaded.
*
* @access private
* @var bool
*/
private $textdomain_loaded;
@@ -163,7 +149,6 @@ final class WP_Theme implements ArrayAccess {
/**
* Stores an md5 hash of the theme root, to function as the cache key.
*
* @access private
* @var string
*/
private $cache_hash;
@@ -174,7 +159,6 @@ final class WP_Theme implements ArrayAccess {
* Default is false. Can be set with the {@see 'wp_cache_themes_persistently'} filter.
*
* @static
* @access private
* @var bool
*/
private static $persistently_cache;
@@ -185,7 +169,6 @@ final class WP_Theme implements ArrayAccess {
* By default the bucket is not cached, so this value is useless.
*
* @static
* @access private
* @var bool
*/
private static $cache_expiration = 1800;
@@ -511,7 +494,6 @@ final class WP_Theme implements ArrayAccess {
* Returns errors property.
*
* @since 3.4.0
* @access public
*
* @return WP_Error|false WP_Error if there are errors, or false.
*/
@@ -526,7 +508,6 @@ final class WP_Theme implements ArrayAccess {
* meaning that the theme's directory was not found, does not exist.
*
* @since 3.4.0
* @access public
*
* @return bool Whether the theme exists.
*/
@@ -538,7 +519,6 @@ final class WP_Theme implements ArrayAccess {
* Returns reference to the parent theme.
*
* @since 3.4.0
* @access public
*
* @return WP_Theme|false Parent theme, or false if the current theme is not a child theme.
*/
@@ -552,7 +532,6 @@ final class WP_Theme implements ArrayAccess {
* Cache entries keyed by the theme and the type of data.
*
* @since 3.4.0
* @access private
*
* @param string $key Type of data to store (theme, screenshot, headers, post_templates)
* @param string $data Data to store
@@ -568,7 +547,6 @@ final class WP_Theme implements ArrayAccess {
* Cache entries are keyed by the theme and the type of data.
*
* @since 3.4.0
* @access private
*
* @param string $key Type of data to retrieve (theme, screenshot, headers, post_templates)
* @return mixed Retrieved data
@@ -581,7 +559,6 @@ final class WP_Theme implements ArrayAccess {
* Clears the cache for the theme.
*
* @since 3.4.0
* @access public
*/
public function cache_delete() {
foreach ( array( 'theme', 'screenshot', 'headers', 'post_templates' ) as $key )
@@ -603,7 +580,6 @@ final class WP_Theme implements ArrayAccess {
* whether it is actually valid.
*
* @since 3.4.0
* @access public
*
* @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
* @return string|false String on success, false on failure.
@@ -637,7 +613,6 @@ final class WP_Theme implements ArrayAccess {
* Gets a theme header, formatted and translated for display.
*
* @since 3.4.0
* @access public
*
* @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
* @param bool $markup Optional. Whether to mark up the header. Defaults to true.
@@ -666,7 +641,6 @@ final class WP_Theme implements ArrayAccess {
* Sanitize a theme header.
*
* @since 3.4.0
* @access private
*
* @staticvar array $header_tags
* @staticvar array $header_tags_with_a
@@ -725,7 +699,6 @@ final class WP_Theme implements ArrayAccess {
* Mark up a theme header.
*
* @since 3.4.0
* @access private
*
* @staticvar string $comma
*
@@ -772,7 +745,6 @@ final class WP_Theme implements ArrayAccess {
* Translate a theme header.
*
* @since 3.4.0
* @access private
*
* @staticvar array $tags_list
*
@@ -836,7 +808,6 @@ final class WP_Theme implements ArrayAccess {
* Otherwise, get_stylesheet() is the same as get_template().
*
* @since 3.4.0
* @access public
*
* @return string Stylesheet
*/
@@ -851,7 +822,6 @@ final class WP_Theme implements ArrayAccess {
* Otherwise, the get_template() is the same as get_stylesheet().
*
* @since 3.4.0
* @access public
*
* @return string Template
*/
@@ -866,7 +836,6 @@ final class WP_Theme implements ArrayAccess {
* of the child theme's files.
*
* @since 3.4.0
* @access public
*
* @return string Absolute path of the stylesheet directory.
*/
@@ -884,7 +853,6 @@ final class WP_Theme implements ArrayAccess {
* of the parent theme's files.
*
* @since 3.4.0
* @access public
*
* @return string Absolute path of the template directory.
*/
@@ -904,7 +872,6 @@ final class WP_Theme implements ArrayAccess {
* child theme's files.
*
* @since 3.4.0
* @access public
*
* @return string URL to the stylesheet directory.
*/
@@ -919,7 +886,6 @@ final class WP_Theme implements ArrayAccess {
* parent theme's files.
*
* @since 3.4.0
* @access public
*
* @return string URL to the template directory.
*/
@@ -938,7 +904,6 @@ final class WP_Theme implements ArrayAccess {
* This is typically the absolute path to wp-content/themes.
*
* @since 3.4.0
* @access public
*
* @return string Theme root.
*/
@@ -954,7 +919,6 @@ final class WP_Theme implements ArrayAccess {
* get_theme_root_uri() and allow it to run the {@see 'theme_root_uri'} filter.
*
* @since 3.4.0
* @access public
*
* @return string Theme root URI.
*/
@@ -973,7 +937,6 @@ final class WP_Theme implements ArrayAccess {
* themes, parent theme screenshots are not inherited.)
*
* @since 3.4.0
* @access public
*
* @param string $uri Type of URL to return, either 'relative' or an absolute URI. Defaults to absolute URI.
* @return string|false Screenshot file. False if the theme does not have a screenshot.
@@ -1005,7 +968,6 @@ final class WP_Theme implements ArrayAccess {
* Return files in the theme's directory.
*
* @since 3.4.0
* @access public
*
* @param mixed $type Optional. Array of extensions to return. Defaults to all files (null).
* @param int $depth Optional. How deep to search for files. Defaults to a flat scan (0 depth). -1 depth is infinite.
@@ -1026,7 +988,6 @@ final class WP_Theme implements ArrayAccess {
* Returns the theme's post templates.
*
* @since 4.7.0
* @access public
*
* @return array Array of page templates, keyed by filename and post type,
* with the value of the translated header name.
@@ -1083,7 +1044,6 @@ final class WP_Theme implements ArrayAccess {
*
* @since 3.4.0
* @since 4.7.0 Added the `$post_type` parameter.
* @access public
*
* @param WP_Post|null $post Optional. The post being edited, provided for context.
* @param string $post_type Optional. Post type to get the templates for. Default 'page'.
@@ -1126,7 +1086,6 @@ final class WP_Theme implements ArrayAccess {
* @since 3.4.0
*
* @static
* @access private
*
* @param string $path Absolute path to search.
* @param array|string|null $extensions Optional. Array of extensions to find, string of a single extension,
@@ -1188,7 +1147,6 @@ final class WP_Theme implements ArrayAccess {
* child theme, it should probably try to load the parent theme's translations.
*
* @since 3.4.0
* @access public
*
* @return bool True if the textdomain was successfully loaded or has already been loaded.
* False if no textdomain was specified in the file headers, or if the domain could not be loaded.
@@ -1222,7 +1180,6 @@ final class WP_Theme implements ArrayAccess {
* Whether the theme is allowed (multisite only).
*
* @since 3.4.0
* @access public
*
* @param string $check Optional. Whether to check only the 'network'-wide settings, the 'site'
* settings, or 'both'. Defaults to 'both'.
@@ -1273,7 +1230,6 @@ final class WP_Theme implements ArrayAccess {
* @since 3.4.0
*
* @static
* @access public
*
* @param int $blog_id Optional. ID of the site. Defaults to the current site.
* @return array Array of stylesheet names.
@@ -1300,7 +1256,6 @@ final class WP_Theme implements ArrayAccess {
* @since 3.4.0
*
* @static
* @access public
*
* @staticvar array $allowed_themes
*
@@ -1330,7 +1285,6 @@ final class WP_Theme implements ArrayAccess {
* @since 3.4.0
*
* @static
* @access public
*
* @staticvar array $allowed_themes
*
@@ -1409,7 +1363,6 @@ final class WP_Theme implements ArrayAccess {
* Enables a theme for all sites on the current network.
*
* @since 4.6.0
* @access public
* @static
*
* @param string|array $stylesheets Stylesheet name or array of stylesheet names.
@@ -1435,7 +1388,6 @@ final class WP_Theme implements ArrayAccess {
* Disables a theme for all sites on the current network.
*
* @since 4.6.0
* @access public
* @static
*
* @param string|array $stylesheets Stylesheet name or array of stylesheet names.
@@ -1465,7 +1417,6 @@ final class WP_Theme implements ArrayAccess {
* @since 3.4.0
*
* @static
* @access public
*
* @param array $themes Array of themes to sort, passed by reference.
*/
@@ -1486,7 +1437,6 @@ final class WP_Theme implements ArrayAccess {
* @since 3.4.0
*
* @static
* @access private
*
* @param string $a First name.
* @param string $b Second name.
@@ -1503,7 +1453,6 @@ final class WP_Theme implements ArrayAccess {
* @since 3.4.0
*
* @static
* @access private
*
* @param string $a First name.
* @param string $b Second name.