Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-06-28 15:54:57 +02:00
Code Issues Projects Releases Wiki Activity

Add missing doc blocks to class-wp-theme.php.

Browse Source 
See #32444.

Built from https://develop.svn.wordpress.org/trunk@32547


git-svn-id: http://core.svn.wordpress.org/trunk@32517 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor 2015-05-22 17:31:27 +00:00
parent bf43be3e9e
commit 1b960d56b6
3 changed files with 77 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
wp-includes/class-wp-theme.php
View File

@ -49,6 +49,10 @@ final class WP_Theme implements ArrayAccess {
/** /**
* Renamed theme tags. * Renamed theme tags.
*
* @static
* @access private
* @var array
*/ */
private static $tag_map = array( private static $tag_map = array(
'fixed-width' => 'fixed-layout', 'fixed-width' => 'fixed-layout',
@ -83,6 +87,9 @@ final class WP_Theme implements ArrayAccess {
* Header name from the theme's style.css after being translated. * Header name from the theme's style.css after being translated.
* *
* Cached due to sorting functions running over the translated name. * Cached due to sorting functions running over the translated name.
*
* @access private
* @var string
*/ */
private $name_translated; private $name_translated;
@ -153,6 +160,7 @@ final class WP_Theme implements ArrayAccess {
* *
* Default is false. Can be set with the wp_cache_themes_persistently filter. * Default is false. Can be set with the wp_cache_themes_persistently filter.
* *
* @static
* @access private * @access private
* @var bool * @var bool
*/ */
@ -163,6 +171,7 @@ final class WP_Theme implements ArrayAccess {
* *
* By default the bucket is not cached, so this value is useless. * By default the bucket is not cached, so this value is useless.
* *
* @static
* @access private * @access private
* @var bool * @var bool
*/ */
@ -171,6 +180,8 @@ final class WP_Theme implements ArrayAccess {
/** /**
* Constructor for WP_Theme. * Constructor for WP_Theme.
* *
* @global array $wp_theme_directories
*
* @param string $theme_dir Directory of the theme within the theme_root. * @param string $theme_dir Directory of the theme within the theme_root.
* @param string $theme_root Theme root. * @param string $theme_root Theme root.
* @param WP_Error|null $_child If this theme is a parent theme, the child may be passed for validation purposes. * @param WP_Error|null $_child If this theme is a parent theme, the child may be passed for validation purposes.
@ -310,6 +321,10 @@ final class WP_Theme implements ArrayAccess {
/** /**
* __isset() magic method for properties formerly returned by current_theme_info() * __isset() magic method for properties formerly returned by current_theme_info()
*
* @staticvar array $properties
*
* @return bool
*/ */
public function __isset( $offset ) { public function __isset( $offset ) {
static $properties = array( static $properties = array(
@ -322,6 +337,8 @@ final class WP_Theme implements ArrayAccess {
/** /**
* __get() magic method for properties formerly returned by current_theme_info() * __get() magic method for properties formerly returned by current_theme_info()
*
* @return mixed
*/ */
public function __get( $offset ) { public function __get( $offset ) {
switch ( $offset ) { switch ( $offset ) {
@ -361,16 +378,26 @@ final class WP_Theme implements ArrayAccess {
/** /**
* Method to implement ArrayAccess for keys formerly returned by get_themes() * Method to implement ArrayAccess for keys formerly returned by get_themes()
*
* @param mixed $offset
* @param mixed $value
*/ */
public function offsetSet( $offset, $value ) {} public function offsetSet( $offset, $value ) {}
/** /**
* Method to implement ArrayAccess for keys formerly returned by get_themes() * Method to implement ArrayAccess for keys formerly returned by get_themes()
*
* @param mixed $offset
*/ */
public function offsetUnset( $offset ) {} public function offsetUnset( $offset ) {}
/** /**
* Method to implement ArrayAccess for keys formerly returned by get_themes() * Method to implement ArrayAccess for keys formerly returned by get_themes()
*
* @staticvar array $keys
*
* @param mixed $offset
* @return bool
*/ */
public function offsetExists( $offset ) { public function offsetExists( $offset ) {
static $keys = array( static $keys = array(
@ -391,6 +418,9 @@ final class WP_Theme implements ArrayAccess {
* untranslated for back compatibility. This means that ['Name'] is not ideal, * untranslated for back compatibility. This means that ['Name'] is not ideal,
* and care should be taken to use $theme->display('Name') to get a properly * and care should be taken to use $theme->display('Name') to get a properly
* translated header. * translated header.
*
* @param mixed $offset
* @return mixed
*/ */
public function offsetGet( $offset ) { public function offsetGet( $offset ) {
switch ( $offset ) { switch ( $offset ) {
@ -443,7 +473,7 @@ final class WP_Theme implements ArrayAccess {
* @since 3.4.0 * @since 3.4.0
* @access public * @access public
* *
* @return WP_Error|bool WP_Error if there are errors, or false. * @return WP_Error|false WP_Error if there are errors, or false.
*/ */
public function errors() { public function errors() {
return is_wp_error( $this->errors ) ? $this->errors : false; return is_wp_error( $this->errors ) ? $this->errors : false;
@ -470,7 +500,7 @@ final class WP_Theme implements ArrayAccess {
* @since 3.4.0 * @since 3.4.0
* @access public * @access public
* *
* @return WP_Theme|bool Parent theme, or false if the current theme is not a child theme. * @return WP_Theme|false Parent theme, or false if the current theme is not a child theme.
*/ */
public function parent() { public function parent() {
return isset( $this->parent ) ? $this->parent : false; return isset( $this->parent ) ? $this->parent : false;
@ -481,8 +511,8 @@ final class WP_Theme implements ArrayAccess {
* *
* Cache entries keyed by the theme and the type of data. * Cache entries keyed by the theme and the type of data.
* *
* @access private
* @since 3.4.0 * @since 3.4.0
* @access private
* *
* @param string $key Type of data to store (theme, screenshot, headers, page_templates) * @param string $key Type of data to store (theme, screenshot, headers, page_templates)
* @param string $data Data to store * @param string $data Data to store
@ -497,8 +527,8 @@ final class WP_Theme implements ArrayAccess {
* *
* Cache entries are keyed by the theme and the type of data. * Cache entries are keyed by the theme and the type of data.
* *
* @access private
* @since 3.4.0 * @since 3.4.0
* @access private
* *
* @param string $key Type of data to retrieve (theme, screenshot, headers, page_templates) * @param string $key Type of data to retrieve (theme, screenshot, headers, page_templates)
* @return mixed Retrieved data * @return mixed Retrieved data
@ -510,8 +540,8 @@ final class WP_Theme implements ArrayAccess {
/** /**
* Clears the cache for the theme. * Clears the cache for the theme.
* *
* @access public
* @since 3.4.0 * @since 3.4.0
* @access public
*/ */
public function cache_delete() { public function cache_delete() {
foreach ( array( 'theme', 'screenshot', 'headers', 'page_templates' ) as $key ) foreach ( array( 'theme', 'screenshot', 'headers', 'page_templates' ) as $key )
@ -532,11 +562,11 @@ final class WP_Theme implements ArrayAccess {
* get_template() takes into account where WordPress actually located the theme and * get_template() takes into account where WordPress actually located the theme and
* whether it is actually valid. * whether it is actually valid.
* *
* @access public
* @since 3.4.0 * @since 3.4.0
* @access public
* *
* @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
* @return string|bool String on success, false on failure. * @return string|false String on success, false on failure.
*/ */
public function get( $header ) { public function get( $header ) {
if ( ! isset( $this->headers[ $header ] ) ) if ( ! isset( $this->headers[ $header ] ) )
@ -566,13 +596,13 @@ final class WP_Theme implements ArrayAccess {
/** /**
* Gets a theme header, formatted and translated for display. * Gets a theme header, formatted and translated for display.
* *
* @access public
* @since 3.4.0 * @since 3.4.0
* @access public
* *
* @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. * @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. * @param bool $markup Optional. Whether to mark up the header. Defaults to true.
* @param bool $translate Optional. Whether to translate the header. Defaults to true. * @param bool $translate Optional. Whether to translate the header. Defaults to true.
* @return string|bool Processed header, false on failure. * @return string|false Processed header, false on failure.
*/ */
public function display( $header, $markup = true, $translate = true ) { public function display( $header, $markup = true, $translate = true ) {
$value = $this->get( $header ); $value = $this->get( $header );
@ -595,8 +625,15 @@ final class WP_Theme implements ArrayAccess {
/** /**
* Sanitize a theme header. * Sanitize a theme header.
* *
* @since 3.4.0
* @access private
*
* @staticvar array $header_tags
* @staticvar array $header_tags_with_a
*
* @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
* @param string $value Value to sanitize. * @param string $value Value to sanitize.
* @return mixed
*/ */
private function sanitize_header( $header, $value ) { private function sanitize_header( $header, $value ) {
switch ( $header ) { switch ( $header ) {
@ -647,8 +684,10 @@ final class WP_Theme implements ArrayAccess {
/** /**
* Mark up a theme header. * Mark up a theme header.
* *
* @since 3.4.0
* @access private * @access private
* @since 3.4.0 *
* @stativar string $comma
* *
* @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
* @param string $value Value to mark up. * @param string $value Value to mark up.
@ -691,8 +730,10 @@ final class WP_Theme implements ArrayAccess {
/** /**
* Translate a theme header. * Translate a theme header.
* *
* @access private
* @since 3.4.0 * @since 3.4.0
* @access private
*
* @staticvar array $tags_list
* *
* @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
* @param string $value Value to translate. * @param string $value Value to translate.
@ -881,7 +922,7 @@ final class WP_Theme implements ArrayAccess {
* @access public * @access public
* *
* @param string $uri Type of URL to return, either 'relative' or an absolute URI. Defaults to absolute URI. * @param string $uri Type of URL to return, either 'relative' or an absolute URI. Defaults to absolute URI.
* @return mixed Screenshot file. False if the theme does not have a screenshot. * @return string|false Screenshot file. False if the theme does not have a screenshot.
*/ */
public function get_screenshot( $uri = 'uri' ) { public function get_screenshot( $uri = 'uri' ) {
$screenshot = $this->cache_get( 'screenshot' ); $screenshot = $this->cache_get( 'screenshot' );
@ -916,7 +957,7 @@ final class WP_Theme implements ArrayAccess {
* @param int $depth Optional. How deep to search for files. Defaults to a flat scan (0 depth). -1 depth is infinite. * @param int $depth Optional. How deep to search for files. Defaults to a flat scan (0 depth). -1 depth is infinite.
* @param bool $search_parent Optional. Whether to return parent files. Defaults to false. * @param bool $search_parent Optional. Whether to return parent files. Defaults to false.
* @return array Array of files, keyed by the path to the file relative to the theme's directory, with the values * @return array Array of files, keyed by the path to the file relative to the theme's directory, with the values
* being absolute paths. * being absolute paths.
*/ */
public function get_files( $type = null, $depth = 0, $search_parent = false ) { public function get_files( $type = null, $depth = 0, $search_parent = false ) {
$files = (array) self::scandir( $this->get_stylesheet_directory(), $type, $depth ); $files = (array) self::scandir( $this->get_stylesheet_directory(), $type, $depth );
@ -987,6 +1028,7 @@ final class WP_Theme implements ArrayAccess {
* Scans a directory for files of a certain extension. * Scans a directory for files of a certain extension.
* *
* @since 3.4.0 * @since 3.4.0
*
* @static * @static
* @access private * @access private
* *
@ -1104,6 +1146,8 @@ final class WP_Theme implements ArrayAccess {
* Returns array of stylesheet names of themes allowed on the site or network. * Returns array of stylesheet names of themes allowed on the site or network.
* *
* @since 3.4.0 * @since 3.4.0
*
* @static
* @access public * @access public
* *
* @param int $blog_id Optional. Defaults to current blog. * @param int $blog_id Optional. Defaults to current blog.
@ -1125,8 +1169,12 @@ final class WP_Theme implements ArrayAccess {
* Returns array of stylesheet names of themes allowed on the network. * Returns array of stylesheet names of themes allowed on the network.
* *
* @since 3.4.0 * @since 3.4.0
*
* @static
* @access public * @access public
* *
* @staticvar array $allowed_themes
*
* @return array Array of stylesheet names. * @return array Array of stylesheet names.
*/ */
public static function get_allowed_on_network() { public static function get_allowed_on_network() {
@ -1140,8 +1188,12 @@ final class WP_Theme implements ArrayAccess {
* Returns array of stylesheet names of themes allowed on the site. * Returns array of stylesheet names of themes allowed on the site.
* *
* @since 3.4.0 * @since 3.4.0
*
* @static
* @access public * @access public
* *
* @staticvar array $allowed_themes
*
* @param int $blog_id Optional. Defaults to current blog. * @param int $blog_id Optional. Defaults to current blog.
* @return array Array of stylesheet names. * @return array Array of stylesheet names.
*/ */
@ -1207,6 +1259,8 @@ final class WP_Theme implements ArrayAccess {
* Sort themes by name. * Sort themes by name.
* *
* @since 3.4.0 * @since 3.4.0
*
* @static
* @access public * @access public
*/ */
public static function sort_by_name( &$themes ) { public static function sort_by_name( &$themes ) {
@ -1224,7 +1278,11 @@ final class WP_Theme implements ArrayAccess {
* Would choke on HTML but we don't care enough to slow it down with strip_tags(). * Would choke on HTML but we don't care enough to slow it down with strip_tags().
* *
* @since 3.4.0 * @since 3.4.0
*
* @static
* @access private * @access private
*
* @return int
*/ */
private static function _name_sort( $a, $b ) { private static function _name_sort( $a, $b ) {
return strnatcasecmp( $a->headers['Name'], $b->headers['Name'] ); return strnatcasecmp( $a->headers['Name'], $b->headers['Name'] );
@ -1234,7 +1292,11 @@ final class WP_Theme implements ArrayAccess {
* Name sort (with translation). * Name sort (with translation).
* *
* @since 3.4.0 * @since 3.4.0
*
* @static
* @access private * @access private
*
* @return int
*/ */
private static function _name_sort_i18n( $a, $b ) { private static function _name_sort_i18n( $a, $b ) {
// Don't mark up; Do translate. // Don't mark up; Do translate.

2
wp-includes/comment.php
View File

@ -454,7 +454,7 @@ class WP_Comment_Query {
* @access public * @access public
* *
* @param string|array $query Array or URL query string of parameters. * @param string|array $query Array or URL query string of parameters.
* @return array List of comments. * @return array|int List of comments, or number of comments when 'count' is passed as a query var.
*/ */
public function query( $query ) { public function query( $query ) {
$this->query_vars = wp_parse_args( $query ); $this->query_vars = wp_parse_args( $query );

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.3-alpha-32546'; $wp_version = '4.3-alpha-32547';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.