WordPress.org

Make WordPress Core

Changeset 32547


Ignore:
Timestamp:
05/22/2015 05:30:44 PM (5 years ago)
Author:
wonderboymusic
Message:

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

See #32444.

Location:
trunk/src/wp-includes
Files:
2 edited

Legend:

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

    r32345 r32547  
    5050    /**
    5151     * Renamed theme tags.
     52     *
     53     * @static
     54     * @access private
     55     * @var array
    5256     */
    5357    private static $tag_map = array(
     
    8488     *
    8589     * Cached due to sorting functions running over the translated name.
     90     *
     91     * @access private
     92     * @var string
    8693     */
    8794    private $name_translated;
     
    154161     * Default is false. Can be set with the wp_cache_themes_persistently filter.
    155162     *
     163     * @static
    156164     * @access private
    157165     * @var bool
     
    164172     * By default the bucket is not cached, so this value is useless.
    165173     *
     174     * @static
    166175     * @access private
    167176     * @var bool
     
    171180    /**
    172181     * Constructor for WP_Theme.
     182     *
     183     * @global array $wp_theme_directories
    173184     *
    174185     * @param string $theme_dir Directory of the theme within the theme_root.
     
    311322    /**
    312323     * __isset() magic method for properties formerly returned by current_theme_info()
     324     *
     325     * @staticvar array $properties
     326     *
     327     * @return bool
    313328     */
    314329    public function __isset( $offset ) {
     
    323338    /**
    324339     * __get() magic method for properties formerly returned by current_theme_info()
     340     *
     341     * @return mixed
    325342     */
    326343    public function __get( $offset ) {
     
    362379    /**
    363380     * Method to implement ArrayAccess for keys formerly returned by get_themes()
     381     *
     382     * @param mixed $offset
     383     * @param mixed $value
    364384     */
    365385    public function offsetSet( $offset, $value ) {}
     
    367387    /**
    368388     * Method to implement ArrayAccess for keys formerly returned by get_themes()
     389     *
     390     * @param mixed $offset
    369391     */
    370392    public function offsetUnset( $offset ) {}
     
    372394    /**
    373395     * Method to implement ArrayAccess for keys formerly returned by get_themes()
     396     *
     397     * @staticvar array $keys
     398     *
     399     * @param mixed $offset
     400     * @return bool
    374401     */
    375402    public function offsetExists( $offset ) {
     
    392419     * and care should be taken to use $theme->display('Name') to get a properly
    393420     * translated header.
     421     *
     422     * @param mixed $offset
     423     * @return mixed
    394424     */
    395425    public function offsetGet( $offset ) {
     
    444474     * @access public
    445475     *
    446      * @return WP_Error|bool WP_Error if there are errors, or false.
     476     * @return WP_Error|false WP_Error if there are errors, or false.
    447477     */
    448478    public function errors() {
     
    471501     * @access public
    472502     *
    473      * @return WP_Theme|bool Parent theme, or false if the current theme is not a child theme.
     503     * @return WP_Theme|false Parent theme, or false if the current theme is not a child theme.
    474504     */
    475505    public function parent() {
     
    482512     * Cache entries keyed by the theme and the type of data.
    483513     *
    484      * @access private
    485      * @since 3.4.0
     514     * @since 3.4.0
     515     * @access private
    486516     *
    487517     * @param string $key Type of data to store (theme, screenshot, headers, page_templates)
     
    498528     * Cache entries are keyed by the theme and the type of data.
    499529     *
    500      * @access private
    501      * @since 3.4.0
     530     * @since 3.4.0
     531     * @access private
    502532     *
    503533     * @param string $key Type of data to retrieve (theme, screenshot, headers, page_templates)
     
    511541     * Clears the cache for the theme.
    512542     *
    513      * @access public
    514      * @since 3.4.0
     543     * @since 3.4.0
     544     * @access public
    515545     */
    516546    public function cache_delete() {
     
    533563     * whether it is actually valid.
    534564     *
    535      * @access public
    536      * @since 3.4.0
     565     * @since 3.4.0
     566     * @access public
    537567     *
    538568     * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
    539      * @return string|bool String on success, false on failure.
     569     * @return string|false String on success, false on failure.
    540570     */
    541571    public function get( $header ) {
     
    567597     * Gets a theme header, formatted and translated for display.
    568598     *
    569      * @access public
    570      * @since 3.4.0
     599     * @since 3.4.0
     600     * @access public
    571601     *
    572602     * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
    573603     * @param bool $markup Optional. Whether to mark up the header. Defaults to true.
    574604     * @param bool $translate Optional. Whether to translate the header. Defaults to true.
    575      * @return string|bool Processed header, false on failure.
     605     * @return string|false Processed header, false on failure.
    576606     */
    577607    public function display( $header, $markup = true, $translate = true ) {
     
    596626     * Sanitize a theme header.
    597627     *
     628     * @since 3.4.0
     629     * @access private
     630     *
     631     * @staticvar array $header_tags
     632     * @staticvar array $header_tags_with_a
     633     *
    598634     * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
    599635     * @param string $value Value to sanitize.
     636     * @return mixed
    600637     */
    601638    private function sanitize_header( $header, $value ) {
     
    648685     * Mark up a theme header.
    649686     *
    650      * @access private
    651      * @since 3.4.0
     687     * @since 3.4.0
     688     * @access private
     689     *
     690     * @stativar string $comma
    652691     *
    653692     * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
     
    692731     * Translate a theme header.
    693732     *
    694      * @access private
    695      * @since 3.4.0
     733     * @since 3.4.0
     734     * @access private
     735     *
     736     * @staticvar array $tags_list
    696737     *
    697738     * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
     
    882923     *
    883924     * @param string $uri Type of URL to return, either 'relative' or an absolute URI. Defaults to absolute URI.
    884      * @return mixed Screenshot file. False if the theme does not have a screenshot.
     925     * @return string|false Screenshot file. False if the theme does not have a screenshot.
    885926     */
    886927    public function get_screenshot( $uri = 'uri' ) {
     
    917958     * @param bool $search_parent Optional. Whether to return parent files. Defaults to false.
    918959     * @return array Array of files, keyed by the path to the file relative to the theme's directory, with the values
    919      *  being absolute paths.
     960     *               being absolute paths.
    920961     */
    921962    public function get_files( $type = null, $depth = 0, $search_parent = false ) {
     
    9881029     *
    9891030     * @since 3.4.0
     1031     *
    9901032     * @static
    9911033     * @access private
     
    11051147     *
    11061148     * @since 3.4.0
     1149     *
     1150     * @static
    11071151     * @access public
    11081152     *
     
    11261170     *
    11271171     * @since 3.4.0
    1128      * @access public
     1172     *
     1173     * @static
     1174     * @access public
     1175     *
     1176     * @staticvar array $allowed_themes
    11291177     *
    11301178     * @return array Array of stylesheet names.
     
    11411189     *
    11421190     * @since 3.4.0
    1143      * @access public
     1191     *
     1192     * @static
     1193     * @access public
     1194     *
     1195     * @staticvar array $allowed_themes
    11441196     *
    11451197     * @param int $blog_id Optional. Defaults to current blog.
     
    12081260     *
    12091261     * @since 3.4.0
     1262     *
     1263     * @static
    12101264     * @access public
    12111265     */
     
    12251279     *
    12261280     * @since 3.4.0
    1227      * @access private
     1281     *
     1282     * @static
     1283     * @access private
     1284     *
     1285     * @return int
    12281286     */
    12291287    private static function _name_sort( $a, $b ) {
     
    12351293     *
    12361294     * @since 3.4.0
    1237      * @access private
     1295     *
     1296     * @static
     1297     * @access private
     1298     *
     1299     * @return int
    12381300     */
    12391301    private static function _name_sort_i18n( $a, $b ) {
  • trunk/src/wp-includes/comment.php

    r32500 r32547  
    455455     *
    456456     * @param string|array $query Array or URL query string of parameters.
    457      * @return array List of comments.
     457     * @return array|int List of comments, or number of comments when 'count' is passed as a query var.
    458458     */
    459459    public function query( $query ) {
Note: See TracChangeset for help on using the changeset viewer.