WordPress.org
Get WordPress

Make WordPress Core

Changeset 58082


Ignore:
Timestamp:
05/02/2024 05:18:53 PM (4 months ago)
Author:
SergeyBiryukov
Message:

Docs: Add missing documentation for various upgrade/install class methods.

Follow-up to [13602], [13686], [14879], [25806], [28495], [32655], [48661], [53952].

Props yagniksangani, audrasjb, SergeyBiryukov.
Fixes #61124.

Location:
trunk/src/wp-admin/includes
Files:
7 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/includes/class-bulk-plugin-upgrader-skin.php

    r53952 r58082  
    2424     * with info retrieved from the get_plugin_data() function.
    2525     *
     26     * @since 3.0.0
    2627     * @var array Plugin data. Values will be empty if not supplied by the plugin.
    2728     */
    2829    public $plugin_info = array();
    2930
     31    /**
     32     * Sets up the strings used in the update process.
     33     *
     34     * @since 3.0.0
     35     */
    3036    public function add_strings() {
    3137        parent::add_strings();
    … …  
    3541
    3642    /**
     43     * Performs an action before a bulk plugin update.
     44     *
     45     * @since 3.0.0
     46     *
    3747     * @param string $title
    3848     */
    … …  
    4252
    4353    /**
     54     * Performs an action following a bulk plugin update.
     55     *
     56     * @since 3.0.0
     57     *
    4458     * @param string $title
    4559     */
    … …  
    5064
    5165    /**
     66     * Displays the footer following the bulk update process.
     67     *
     68     * @since 3.0.0
    5269     */
    5370    public function bulk_footer() {

  • trunk/src/wp-admin/includes/class-bulk-theme-upgrader-skin.php

    r53952 r58082  
    2525     * which in turn calls the wp_get_theme() function.
    2626     *
     27     * @since 3.0.0
    2728     * @var WP_Theme|false The theme's info object, or false.
    2829     */
    2930    public $theme_info = false;
    3031
     32    /**
     33     * Sets up the strings used in the update process.
     34     *
     35     * @since 3.0.0
     36     */
    3137    public function add_strings() {
    3238        parent::add_strings();
    … …  
    3642
    3743    /**
     44     * Performs an action before a bulk theme update.
     45     *
     46     * @since 3.0.0
     47     *
    3848     * @param string $title
    3949     */
    … …  
    4353
    4454    /**
     55     * Performs an action following a bulk theme update.
     56     *
     57     * @since 3.0.0
     58     *
    4559     * @param string $title
    4660     */
    … …  
    5165
    5266    /**
     67     * Displays the footer following the bulk update process.
     68     *
     69     * @since 3.0.0
    5370     */
    5471    public function bulk_footer() {

  • trunk/src/wp-admin/includes/class-bulk-upgrader-skin.php

    r56599 r58082  
    1717 */
    1818class Bulk_Upgrader_Skin extends WP_Upgrader_Skin {
     19
     20    /**
     21     * Whether the bulk update process has started.
     22     *
     23     * @since 3.0.0
     24     * @var bool
     25     */
    1926    public $in_loop = false;
    20     /**
     27
     28    /**
     29     * Stores an error message about the update.
     30     *
     31     * @since 3.0.0
    2132     * @var string|false
    2233     */
    … …  
    2435
    2536    /**
     37     * Constructor.
     38     *
     39     * Sets up the generic skin for the Bulk Upgrader classes.
     40     *
     41     * @since 3.0.0
     42     *
    2643     * @param array $args
    2744     */
    … …  
    3754
    3855    /**
     56     * Sets up the strings used in the update process.
     57     *
     58     * @since 3.0.0
    3959     */
    4060    public function add_strings() {
    … …  
    5070
    5171    /**
     72     * Displays a message about the update.
     73     *
     74     * @since 3.0.0
    5275     * @since 5.9.0 Renamed `$string` (a PHP reserved keyword) to `$feedback` for PHP 8 named parameter support.
    5376     *
    … …  
    78101
    79102    /**
     103     * Displays the header before the update process.
     104     *
     105     * @since 3.0.0
    80106     */
    81107    public function header() {
    … …  
    84110
    85111    /**
     112     * Displays the footer following the update process.
     113     *
     114     * @since 3.0.0
    86115     */
    87116    public function footer() {
    … …  
    90119
    91120    /**
     121     * Displays an error message about the update.
     122     *
     123     * @since 3.0.0
    92124     * @since 5.9.0 Renamed `$error` to `$errors` for PHP 8 named parameter support.
    93125     *
    … …  
    114146
    115147    /**
     148     * Displays the header before the bulk update process.
     149     *
     150     * @since 3.0.0
    116151     */
    117152    public function bulk_header() {
    … …  
    120155
    121156    /**
     157     * Displays the footer following the bulk update process.
     158     *
     159     * @since 3.0.0
    122160     */
    123161    public function bulk_footer() {
    … …  
    126164
    127165    /**
     166     * Performs an action before a bulk update.
     167     *
     168     * @since 3.0.0
     169     *
    128170     * @param string $title
    129171     */
    … …  
    138180
    139181    /**
     182     * Performs an action following a bulk update.
     183     *
     184     * @since 3.0.0
     185     *
    140186     * @param string $title
    141187     */
    … …  
    173219
    174220    /**
     221     * Resets the properties used in the update process.
     222     *
     223     * @since 3.0.0
    175224     */
    176225    public function reset() {
    … …  
    180229
    181230    /**
     231     * Flushes all output buffers.
     232     *
     233     * @since 3.0.0
    182234     */
    183235    public function flush_output() {

  • trunk/src/wp-admin/includes/class-language-pack-upgrader-skin.php

    r51782 r58082  
    2323
    2424    /**
     25     * Constructor.
     26     *
     27     * Sets up the language pack upgrader skin.
     28     *
     29     * @since 3.7.0
     30     *
    2531     * @param array $args
    2632     */
    … …  
    4248
    4349    /**
     50     * Performs an action before a language pack update.
     51     *
     52     * @since 3.7.0
    4453     */
    4554    public function before() {
    … …  
    5362
    5463    /**
     64     * Displays an error message about the update.
     65     *
     66     * @since 3.7.0
    5567     * @since 5.9.0 Renamed `$error` to `$errors` for PHP 8 named parameter support.
    5668     *
    … …  
    6476
    6577    /**
     78     * Performs an action following a language pack update.
     79     *
     80     * @since 3.7.0
    6681     */
    6782    public function after() {
    … …  
    7085
    7186    /**
     87     * Displays the footer following the bulk update process.
     88     *
     89     * @since 3.7.0
    7290     */
    7391    public function bulk_footer() {

  • trunk/src/wp-admin/includes/class-plugin-installer-skin.php

    r57793 r58082  
    2525
    2626    /**
     27     * Constructor.
     28     *
     29     * Sets up the plugin installer skin.
     30     *
     31     * @since 2.8.0
     32     *
    2733     * @param array $args
    2834     */

  • trunk/src/wp-admin/includes/class-theme-installer-skin.php

    r57793 r58082  
    2525
    2626    /**
     27     * Constructor.
     28     *
     29     * Sets up the theme installer skin.
     30     *
     31     * @since 2.8.0
     32     *
    2733     * @param array $args
    2834     */

  • trunk/src/wp-admin/includes/class-wp-upgrader-skin.php

    r57148 r58082  
    2121     *
    2222     * @since 2.8.0
    23      *
    2423     * @var WP_Upgrader
    2524     */
    … …  
    3029     *
    3130     * @since 2.8.0
    32      *
    3331     * @var bool
    3432     */
    … …  
    3937     *
    4038     * @since 2.8.0
    41      *
    4239     * @var bool
    4340     */
    … …  
    4845     *
    4946     * @since 2.8.0
    50      *
    5147     * @var string|bool|WP_Error
    5248     */
    … …  
    5753     *
    5854     * @since 2.8.0
    59      *
    6055     * @var array
    6156     */
    … …  
    8378
    8479    /**
     80     * Sets the relationship between the skin being used and the upgrader.
     81     *
    8582     * @since 2.8.0
    8683     *
    … …  
    9592
    9693    /**
     94     * Sets up the strings used in the update process.
     95     *
    9796     * @since 3.0.0
    9897     */
    … …  
    142141
    143142    /**
     143     * Displays the header before the update process.
     144     *
    144145     * @since 2.8.0
    145146     */
    … …  
    154155
    155156    /**
     157     * Displays the footer following the update process.
     158     *
    156159     * @since 2.8.0
    157160     */
    … …  
    165168
    166169    /**
     170     * Displays an error message about the update.
     171     *
    167172     * @since 2.8.0
    168173     *
    … …  
    187192
    188193    /**
     194     * Displays a message about the update.
     195     *
    189196     * @since 2.8.0
    190197     * @since 5.9.0 Renamed `$string` (a PHP reserved keyword) to `$feedback` for PHP 8 named parameter support.
    … …  
    219226
    220227    /**
    221      * Performs and action following an update.
     228     * Performs an action following an update.
    222229     *
    223230     * @since 2.8.0
    … …  
    263270
    264271    /**
     272     * Displays the header before the bulk update process.
     273     *
    265274     * @since 3.0.0
    266275     */
    … …  
    268277
    269278    /**
     279     * Displays the footer following the bulk update process.
     280     *
    270281     * @since 3.0.0
    271282     */
Note: See TracChangeset for help on using the changeset viewer.