WordPress.org

Make WordPress Core


Ignore:
Timestamp:
02/26/2016 01:04:51 PM (5 years ago)
Author:
ocean90
Message:

Docs: Document properties of WP_Scripts and add missing @since tags.

See #35964.

File:
1 edited

Legend:

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

    r36706 r36730  
    1818 */
    1919class WP_Scripts extends WP_Dependencies {
    20     public $base_url; // Full URL with trailing slash
     20    /**
     21     * Base URL for scripts.
     22     *
     23     * Full URL with trailing slash.
     24     *
     25     * @since 2.6.0
     26     * @access public
     27     * @var string
     28     */
     29    public $base_url;
     30
     31    /**
     32     *
     33     * @since 2.8.0
     34     * @access public
     35     * @var string
     36     */
    2137    public $content_url;
     38
     39    /**
     40     *
     41     * @since 2.6.0
     42     * @access public
     43     * @var string
     44     */
    2245    public $default_version;
     46
     47    /**
     48     *
     49     * @since 2.8.0
     50     * @access public
     51     * @var array
     52     */
    2353    public $in_footer = array();
     54
     55    /**
     56     *
     57     * @since 2.8.0
     58     * @access public
     59     * @var string
     60     */
    2461    public $concat = '';
     62
     63    /**
     64     *
     65     * @since 2.8.0
     66     * @access public
     67     * @var string
     68     */
    2569    public $concat_version = '';
     70
     71    /**
     72     *
     73     * @since 2.8.0
     74     * @access public
     75     * @var bool
     76     */
    2677    public $do_concat = false;
     78
     79    /**
     80     *
     81     * @since 2.8.0
     82     * @access public
     83     * @var string
     84     */
    2785    public $print_html = '';
     86
     87    /**
     88     *
     89     * @since 4.5.0
     90     * @access public
     91     * @var string
     92     */
    2893    public $print_html_before = '';
     94
     95    /**
     96     *
     97     * @since 2.8.0
     98     * @access public
     99     * @var string
     100     */
    29101    public $print_code = '';
     102
     103    /**
     104     *
     105     * @since 2.8.0
     106     * @access public
     107     * @var string
     108     */
    30109    public $ext_handles = '';
     110
     111    /**
     112     *
     113     * @since 2.8.0
     114     * @access public
     115     * @var string
     116     */
    31117    public $ext_version = '';
     118
     119    /**
     120     *
     121     * @since 2.8.0
     122     * @access public
     123     * @var array
     124     */
    32125    public $default_dirs;
    33126
     
    65158     * Prints the scripts passed to it or the print queue. Also prints all necessary dependencies.
    66159     *
     160     * @since 2.1.0
     161     * @since 2.8.0 Added the `$group` parameter.
     162     * @access public
     163     *
    67164     * @param mixed $handles Optional. Scripts to be printed. (void) prints queue, (string) prints
    68165     *                       that script, (array of strings) prints those scripts. Default false.
     
    76173
    77174    /**
    78      * @deprecated 3.3
     175     *
     176     * @since 2.1.0
     177     * @since 2.8.0 Added the `$echo` parameter.
     178     * @deprecated 3.3.0
     179     * @access public
     180     *
    79181     * @see print_extra_script()
    80182     *
     
    89191
    90192    /**
     193     *
     194     * @since 3.3.0
     195     * @access public
     196     *
    91197     * @param string $handle
    92198     * @param bool   $echo
     
    110216
    111217    /**
     218     *
     219     * @since 2.6.0
     220     * @since 2.8.0 Added the `$group` parameter.
     221     * @access public
     222     *
    112223     * @param string   $handle Name of the item. Should be unique.
    113224     * @param int|bool $group
     
    298409     * Localizes a script, only if the script has already been added
    299410     *
     411     * @since 2.1.0
     412     * @access public
     413     *
    300414     * @param string $handle
    301415     * @param string $object_name
     
    333447
    334448    /**
     449     *
     450     * @since 2.8.0
     451     * @access public
     452     *
    335453     * @param string $handle    Name of the item. Should be unique.
    336454     * @param bool   $recursion Internal flag that calling function was called recursively.
     
    351469
    352470    /**
     471     *
     472     * @since 2.1.0
     473     * @access public
     474     *
    353475     * @param mixed $handles   Item handle and argument (string) or item handles and arguments (array of strings).
    354476     * @param bool  $recursion Internal flag that function is calling itself.
     
    372494
    373495    /**
     496     *
     497     * @since 2.8.0
     498     * @access public
     499     *
    374500     * @return array
    375501     */
     
    380506
    381507    /**
     508     *
     509     * @since 2.8.0
     510     * @access public
     511     *
    382512     * @return array
    383513     */
     
    388518
    389519    /**
     520     *
     521     * @since 2.8.0
     522     * @access public
     523     *
    390524     * @param string $src
    391525     * @return bool
     
    409543
    410544    /**
     545     *
     546     * @since 2.8.0
    411547     * @access public
    412548     */
Note: See TracChangeset for help on using the changeset viewer.