WordPress.org

Make WordPress Core

Changeset 39166


Ignore:
Timestamp:
11/08/2016 08:15:38 PM (19 months ago)
Author:
DrewAPicture
Message:

Docs: Notate the incoming $theme object members for WP_Theme_Install_List_Table::single_row() as a proper hash notation.

h/t coffee2code.
See #37770.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-wp-theme-install-list-table.php

    r38672 r39166  
    227227     * Prints a theme from the WordPress.org API.
    228228     *
     229     * @since 3.1.0
     230     * @access public
     231     *
    229232     * @global array $themes_allowedtags
    230233     *
    231      * @param object $theme An object that contains theme data returned by the WordPress.org API.
    232      *
    233      * Example theme data:
    234      *   object(stdClass)[59]
    235      *     public 'name' => string 'Magazine Basic'
    236      *     public 'slug' => string 'magazine-basic'
    237      *     public 'version' => string '1.1'
    238      *     public 'author' => string 'tinkerpriest'
    239      *     public 'preview_url' => string 'http://wp-themes.com/?magazine-basic'
    240      *     public 'screenshot_url' => string 'http://wp-themes.com/wp-content/themes/magazine-basic/screenshot.png'
    241      *     public 'rating' => float 80
    242      *     public 'num_ratings' => int 1
    243      *     public 'homepage' => string 'http://wordpress.org/themes/magazine-basic'
    244      *     public 'description' => string 'A basic magazine style layout with a fully customizable layout through a back-end interface. Designed by <a href="http://bavotasan.com">c.bavota</a> of <a href="http://tinkerpriestmedia.com">Tinker Priest Media</a>.'
    245      *     public 'download_link' => string 'http://wordpress.org/themes/download/magazine-basic.1.1.zip'
     234     * @param object $theme {
     235     *     An object that contains theme data returned by the WordPress.org API.
     236     *
     237     *     @type string $name           Theme name, e.g. 'Twenty Seventeen'.
     238     *     @type string $slug           Theme slug, e.g. 'twentyseventeen'.
     239     *     @type string $version        Theme version, e.g. '1.1'.
     240     *     @type string $author         Theme author username, e.g. 'melchoyce'.
     241     *     @type string $preview_url    Preview URL, e.g. 'http://2017.wordpress.net/'.
     242     *     @type string $screenshot_url Screenshot URL, e.g. 'https://wordpress.org/themes/twentyseventeen/'.
     243     *     @type float  $rating         Rating score.
     244     *     @type int    $num_ratings    The number of ratings.
     245     *     @type string $homepage       Theme homepage, e.g. 'https://wordpress.org/themes/twentyseventeen/'.
     246     *     @type string $description    Theme description.
     247     *     @type string $download_link  Theme ZIP download URL.
     248     * }
    246249     */
    247250    public function single_row( $theme ) {
Note: See TracChangeset for help on using the changeset viewer.