Make WordPress Core

Changeset 33684


Ignore:
Timestamp:
08/21/2015 04:04:23 AM (11 years ago)
Author:
DrewAPicture
Message:

Docs: Add missing @access tags to properties and methods in wp-admin/includes/class-wp-upgrader.

See #29086.

File:
1 edited

Legend:

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

    r33683 r33684  
    2727         *
    2828         * @since 2.8.0
     29         * @access public
    2930         * @var string $strings
    3031         */
     
    3536         *
    3637         * @since 2.8.0
     38         * @access public
    3739         * @var WP_Upgrader_Skin $skin
    3840         */
     
    4850         *
    4951         * @since 2.8.0
     52         * @access public
     53         *
    5054         * @var WP_Error|array $result {
    5155         *      @type string $source             The full path to the source the files were installed from.
     
    6973         *
    7074         * @since 3.0.0
     75         * @access public
    7176         * @var int $update_count
    7277         */
     
    7984         *
    8085         * @since 3.0.0
     86         * @access public
    8187         * @var int
    8288         */
     
    8793         *
    8894         * @since 2.8.0
     95         * @access public
    8996         *
    9097         * @param WP_Upgrader_Skin $skin The upgrader skin to use. Default is a {@see WP_Upgrader_Skin}
     
    105112         *
    106113         * @since 2.8.0
     114         * @access public
    107115         */
    108116        public function init() {
     
    115123         *
    116124         * @since 2.8.0
     125         * @access public
    117126         */
    118127        public function generic_strings() {
     
    143152         *
    144153         * @since 2.8.0
     154         * @access public
    145155         *
    146156         * @global WP_Filesystem_Base $wp_filesystem Subclass
     
    206216         *
    207217         * @since 2.8.0
     218         * @access public
    208219         *
    209220         * @param string $package The URI of the package. If this is the full path to an
     
    217228                 *
    218229                 * @since 3.7.0
     230                 * @access public
    219231                 *
    220232                 * @param bool        $reply   Whether to bail without returning the package.
     
    247259         *
    248260         * @since 2.8.0
     261         * @access public
    249262         *
    250263         * @global WP_Filesystem_Base $wp_filesystem Subclass
     
    298311         *
    299312         * @since 4.3.0
     313         * @access public
    300314         *
    301315         * @global WP_Filesystem_Base $wp_filesystem Subclass
     
    361375         *
    362376         * @since 2.8.0
     377         * @access public
    363378         *
    364379         * @global WP_Filesystem_Base $wp_filesystem Subclass
     
    562577         *
    563578         * @since 2.8.0
     579         * @access public
    564580         *
    565581         * @param array $options {
     
    708724         *
    709725         * @since 2.8.0
     726         * @access public
    710727         *
    711728         * @global WP_Filesystem_Base $wp_filesystem Subclass
     
    743760         *
    744761         * @since 2.8.0
     762         * @access public
    745763         * @var array|WP_Error $result
    746764         * @see WP_Upgrader::$result
     
    752770         *
    753771         * @since 2.9.0
     772         * @access public
    754773         * @var bool $bulk
    755774         */
     
    760779         *
    761780         * @since 2.8.0
     781         * @access public
    762782         */
    763783        public function upgrade_strings() {
     
    777797         *
    778798         * @since 2.8.0
     799         * @access public
    779800         */
    780801        public function install_strings() {
     
    793814         * @since 2.8.0
    794815         * @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
     816         * @access public
    795817         *
    796818         * @param string $package The full local path or URI of the package.
     
    843865         * @since 2.8.0
    844866         * @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
     867         * @access public
    845868         *
    846869         * @param string $plugin The basename path to the main plugin file.
     
    909932         * @since 2.8.0
    910933         * @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
     934         * @access public
    911935         *
    912936         * @param array $plugins Array of the basename paths of the plugins' main files.
     
    10411065         *
    10421066         * @since 3.3.0
     1067         * @access public
    10431068         *
    10441069         * @global WP_Filesystem_Base $wp_filesystem Subclass
     
    10821107         *
    10831108         * @since 2.8.0
     1109         * @access public
    10841110         *
    10851111         * @return string|false The full path to the main plugin file, or false.
     
    11071133         * @since 2.8.0
    11081134         * @since 4.1.0 Added a return value.
     1135         * @access public
    11091136         *
    11101137         * @param bool|WP_Error  $return Upgrade offer return.
     
    11401167         *
    11411168         * @since 2.8.0
     1169         * @access public
    11421170         *
    11431171         * @global WP_Filesystem_Base $wp_filesystem Subclass
     
    12101238         *
    12111239         * @since 2.8.0
     1240         * @access public
    12121241         */
    12131242        public function upgrade_strings() {
     
    12261255         *
    12271256         * @since 2.8.0
     1257         * @access public
    12281258         */
    12291259        public function install_strings() {
     
    12531283         *
    12541284         * @since 3.4.0
     1285         * @access public
    12551286         *
    12561287         * @param bool  $install_result
     
    13261357         *
    13271358         * @since 3.4.0
     1359         * @access public
    13281360         *
    13291361         * @param array $actions Preview actions.
     
    13401372         * @since 2.8.0
    13411373         * @since 3.7.0 The `$args` parameter was added, making clearing the update cache optional.
     1374         * @access public
    13421375         *
    13431376         * @param string $package The full local path or URI of the package.
     
    13921425         * @since 2.8.0
    13931426         * @since 3.7.0 The `$args` parameter was added, making clearing the update cache optional.
     1427         * @access public
    13941428         *
    13951429         * @param string $theme The theme slug.
     
    14571491         * @since 3.0.0
    14581492         * @since 3.7.0 The `$args` parameter was added, making clearing the update cache optional.
     1493         * @access public
    14591494         *
    14601495         * @param array $themes The theme slugs.
     
    15771612         *
    15781613         * @since 3.3.0
     1614         * @access public
    15791615         *
    15801616         * @global WP_Filesystem_Base $wp_filesystem Subclass
     
    16171653         *
    16181654         * @since 2.8.0
     1655         * @access public
    16191656         *
    16201657         * @param bool|WP_Error  $return
     
    16441681         *
    16451682         * @since 2.8.0
     1683         * @access public
    16461684         *
    16471685         * @param bool|WP_Error  $return
     
    16781716         *
    16791717         * @since 2.8.0
     1718         * @access public
    16801719         *
    16811720         * @global WP_Filesystem_Base $wp_filesystem Subclass
     
    17111750         * @since 2.8.0
    17121751         * @since 3.0.0 The `$theme` argument was added.
     1752         * @access public
    17131753         *
    17141754         * @param string $theme The directory name of the theme. This is optional, and if not supplied,
     
    17431783         *
    17441784         * @since 3.7.0
     1785         * @access public
    17451786         * @var array|WP_Error $result
    17461787         * @see WP_Upgrader::$result
     
    17521793         *
    17531794         * @since 3.7.0
     1795         * @access public
    17541796         * @var bool $bulk
    17551797         */
     
    17621804         *
    17631805         * @since 3.7.0
     1806         * @access public
    17641807         *
    17651808         * @static
     
    18201863         *
    18211864         * @since 3.7.0
     1865         * @access public
    18221866         */
    18231867        public function upgrade_strings() {
     
    18351879         *
    18361880         * @since 3.7.0
     1881         * @access public
    18371882         *
    18381883         * @param string|false $update Optional. Whether an update offer is available. Default false.
     
    18591904         *
    18601905         * @since 3.7.0
     1906         * @access public
    18611907         *
    18621908         * @global WP_Filesystem_Base $wp_filesystem Subclass
     
    19862032         *
    19872033         * @since 3.7.0
     2034         * @access public
    19882035         *
    19892036         * @global WP_Filesystem_Base $wp_filesystem Subclass
     
    20212068         *
    20222069         * @since 3.7.0
     2070         * @access public
    20232071         *
    20242072         * @param object $update The data for an update.
     
    20602108         *
    20612109         * @since 2.8.0
     2110         * @access public
    20622111         */
    20632112        public function upgrade_strings() {
     
    20762125         *
    20772126         * @since 2.8.0
     2127         * @access public
    20782128         *
    20792129         * @global WP_Filesystem_Base $wp_filesystem Subclass
     
    22462296         *
    22472297         * @since 3.7.0
     2298         * @access public
    22482299         *
    22492300         * @static
     
    23542405         *
    23552406         * @since 3.7.0
     2407         * @access public
    23562408         *
    23572409         * @global string $wp_version
     
    23932445         *
    23942446         * @since 2.8.0
     2447         * @access public
    23952448         * @var string $package
    23962449         */
     
    24012454         *
    24022455         * @since 2.8.0
     2456         * @access public
    24032457         * @var string $filename
    24042458         */
     
    24092463         *
    24102464         * @since 3.3.0
     2465         * @access public
    24112466         * @var int $id
    24122467         */
     
    24172472         *
    24182473         * @since 2.8.0
     2474         * @access public
    24192475         *
    24202476         * @param string $form      The name of the form the file was uploaded from.
     
    24762532         *
    24772533         * @since 3.2.2
     2534         * @access public
    24782535         *
    24792536         * @return bool Whether the cleanup was successful.
     
    25032560         *
    25042561         * @var array
     2562         * @access protected
    25052563         */
    25062564        protected $update_results = array();
     
    25102568         *
    25112569         * @since 3.7.0
     2570         * @access public
    25122571         */
    25132572        public function is_disabled() {
     
    25502609         *
    25512610         * @since 3.7.0
     2611         * @access public
    25522612         *
    25532613         * @param string $context The filesystem path to check, in addition to ABSPATH.
     
    26022662         *
    26032663         * @since 3.7.0
     2664         * @access public
    26042665         *
    26052666         * @global wpdb $wpdb
     
    26852746         *
    26862747         * @since 3.7.0
     2748         * @access protected
    26872749         *
    26882750         * @param object $item The update offer.
     
    27282790         *
    27292791         * @since 3.7.0
     2792         * @access public
    27302793         *
    27312794         * @param string $type The type of update being checked: 'core', 'theme', 'plugin', 'translation'.
     
    28312894         *
    28322895         * @since 3.7.0
     2896         * @access public
    28332897         *
    28342898         * @global wpdb   $wpdb
     
    29683032         * If we tried to perform a core update, check if we should send an email,
    29693033         * and if we need to avoid processing future updates.
     3034         *
     3035         * @since Unknown
     3036         * @access protected
    29703037         *
    29713038         * @global string $wp_version
     
    30573124         *
    30583125         * @since 3.7.0
     3126         * @access protected
    30593127         *
    30603128         * @global string $wp_version
     
    32563324         *
    32573325         * @since 3.7.0
     3326         * @access protected
    32583327         */
    32593328        protected function send_debug_email() {
Note: See TracChangeset for help on using the changeset viewer.