WordPress.org

Make WordPress Core

Changeset 48105


Ignore:
Timestamp:
06/20/2020 12:12:39 PM (18 months ago)
Author:
SergeyBiryukov
Message:

Docs: Miscellaneous DocBlock corrections for plugin and theme installation and updates.

See #49572.

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

Legend:

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

    r48097 r48105  
    277277     * @param string $type The type of update being checked: 'core', 'theme', 'plugin', 'translation'.
    278278     * @param object $item The update offer.
    279      *
    280279     * @return null|WP_Error
    281280     */
     
    10381037         *     @type string $headers Any email headers, defaults to no headers.
    10391038         * }
    1040          * @param string $type               The type of email being sent. Can be one of
    1041          *                                   'success', 'fail', 'mixed'.
    1042          * @param array  $successful_updates The updates that succeeded.
    1043          * @param array  $failed_updates     The updates that failed.
     1039         * @param string $type               The type of email being sent. Can be one of 'success', 'fail', 'mixed'.
     1040         * @param array  $successful_updates A list of updates that succeeded.
     1041         * @param array  $failed_updates     A list of updates that failed.
    10441042         */
    10451043        $email = apply_filters( 'auto_plugin_theme_update_email', $email, $type, $successful_updates, $failed_updates );
  • trunk/src/wp-admin/includes/class-wp-ms-themes-list-table.php

    r48092 r48105  
    640640    public function column_description( $theme ) {
    641641        global $status, $totals;
     642
    642643        if ( $theme->errors() ) {
    643644            $pre = 'broken' === $status ? __( 'Broken Theme:' ) . ' ' : '';
     
    681682            );
    682683        }
     684
    683685        /**
    684686         * Filters the array of row meta for each theme in the Multisite themes
     
    687689         * @since 3.1.0
    688690         *
    689          * @param string[] $theme_meta An array of the theme's metadata,
    690          *                             including the version, author, and
    691          *                             theme URI.
     691         * @param string[] $theme_meta An array of the theme's metadata, including
     692         *                             the version, author, and theme URI.
    692693         * @param string   $stylesheet Directory name of the theme.
    693694         * @param WP_Theme $theme      WP_Theme object.
     
    695696         */
    696697        $theme_meta = apply_filters( 'theme_row_meta', $theme_meta, $stylesheet, $theme, $status );
     698
    697699        echo implode( ' | ', $theme_meta );
    698700
     
    769771         * @since 5.5.0
    770772         *
    771          * @param string   $html       The HTML for theme’s auto-update setting including toggle auto-update action link
    772          *                             and time to next update.
     773         * @param string   $html       The HTML for theme's auto-update setting, including
     774         *                             toggle auto-update action link and time to next update.
    773775         * @param string   $stylesheet Directory name of the theme.
    774776         * @param WP_Theme $theme      WP_Theme object.
  • trunk/src/wp-admin/includes/class-wp-plugin-install-list-table.php

    r47550 r48105  
    118118
    119119        /**
    120          * Filters the tabs shown on the Plugin Install screen.
     120         * Filters the tabs shown on the Add Plugins screen.
    121121         *
    122122         * @since 2.7.0
    123123         *
    124          * @param string[] $tabs The tabs shown on the Plugin Install screen. Defaults include 'featured', 'popular',
    125          *                      'recommended', 'favorites', and 'upload'.
     124         * @param string[] $tabs The tabs shown on the Add Plugins screen. Defaults include
     125         *                       'featured', 'popular', 'recommended', 'favorites', and 'upload'.
    126126         */
    127127        $tabs = apply_filters( 'install_plugins_tabs', $tabs );
    128128
    129129        /**
    130          * Filters tabs not associated with a menu item on the Plugin Install screen.
     130         * Filters tabs not associated with a menu item on the Add Plugins screen.
    131131         *
    132132         * @since 2.7.0
    133133         *
    134          * @param string[] $nonmenu_tabs The tabs that don't have a menu item on the Plugin Install screen.
     134         * @param string[] $nonmenu_tabs The tabs that don't have a menu item on the Add Plugins screen.
    135135         */
    136136        $nonmenu_tabs = apply_filters( 'install_plugins_nonmenu_tabs', $nonmenu_tabs );
     
    208208
    209209        /**
    210          * Filters API request arguments for each Plugin Install screen tab.
     210         * Filters API request arguments for each Add Plugins screen tab.
    211211         *
    212212         * The dynamic portion of the hook name, `$tab`, refers to the plugin install tabs.
     
    215215         * @since 3.7.0
    216216         *
    217          * @param array|bool $args Plugin Install API arguments.
     217         * @param array|false $args Plugin install API arguments.
    218218         */
    219219        $args = apply_filters( "install_plugins_table_api_args_{$tab}", $args );
  • trunk/src/wp-admin/includes/class-wp-plugins-list-table.php

    r48092 r48105  
    10071007                     * @since 2.8.0
    10081008                     *
    1009                      * @param string[] $plugin_meta An array of the plugin's metadata,
    1010                      *                              including the version, author,
    1011                      *                              author URI, and plugin URI.
     1009                     * @param string[] $plugin_meta An array of the plugin's metadata, including
     1010                     *                              the version, author, author URI, and plugin URI.
    10121011                     * @param string   $plugin_file Path to the plugin file relative to the plugins directory.
    10131012                     * @param array    $plugin_data An array of plugin data.
     
    10171016                     */
    10181017                    $plugin_meta = apply_filters( 'plugin_row_meta', $plugin_meta, $plugin_file, $plugin_data, $status );
     1018
    10191019                    echo implode( ' | ', $plugin_meta );
    10201020
     
    10901090                     * @since 5.5.0
    10911091                     *
    1092                      * @param string $html        The HTML of the plugin's auto-update column content,
    1093                      *                            including toggle auto-update action links and time to next update.
     1092                     * @param string $html        The HTML of the plugin's auto-update column content, including
     1093                     *                            toggle auto-update action links and time to next update.
    10941094                     * @param string $plugin_file Path to the plugin file relative to the plugins directory.
    10951095                     * @param array  $plugin_data An array of plugin data.
  • trunk/src/wp-admin/includes/class-wp-theme-install-list-table.php

    r47550 r48105  
    138138         * @since 3.7.0
    139139         *
    140          * @param array $args An array of themes API arguments.
     140         * @param array|false $args Theme install API arguments.
    141141         */
    142142        $args = apply_filters( "install_themes_table_api_args_{$tab}", $args );
  • trunk/src/wp-admin/includes/plugin.php

    r48067 r48105  
    678678             * @param string $plugin       Path to the plugin file relative to the plugins directory.
    679679             * @param bool   $network_wide Whether to enable the plugin for all sites in the network
    680              *                             or just the current site. Multisite only. Default is false.
     680             *                             or just the current site. Multisite only. Default false.
    681681             */
    682682            do_action( 'activate_plugin', $plugin, $network_wide );
     
    693693             *
    694694             * @param bool $network_wide Whether to enable the plugin for all sites in the network
    695              *                           or just the current site. Multisite only. Default is false.
     695             *                           or just the current site. Multisite only. Default false.
    696696             */
    697697            do_action( "activate_{$plugin}", $network_wide );
     
    720720             * @param string $plugin       Path to the plugin file relative to the plugins directory.
    721721             * @param bool   $network_wide Whether to enable the plugin for all sites in the network
    722              *                             or just the current site. Multisite only. Default is false.
     722             *                             or just the current site. Multisite only. Default false.
    723723             */
    724724            do_action( 'activated_plugin', $plugin, $network_wide );
  • trunk/src/wp-admin/themes.php

    r48097 r48105  
    553553
    554554/**
    555  * Returns the template for displaying the auto-update setting for a theme.
     555 * Returns the JavaScript template used to display the auto-update setting for a theme.
    556556 *
    557557 * @since 5.5.0
     
    586586
    587587    /**
    588      * Filters the JavaScript template used in Backbone to display the auto-update setting for a theme (in the overlay).
     588     * Filters the JavaScript template used to display the auto-update setting for a theme (in the overlay).
    589589     *
    590590     * See {@see wp_prepare_themes_for_js()} for the properties of the `data` object.
Note: See TracChangeset for help on using the changeset viewer.