WordPress.org

Make WordPress Core

Changeset 48097


Ignore:
Timestamp:
06/19/2020 10:15:36 PM (15 months ago)
Author:
johnbillion
Message:

Docs: Corrections and improvements to inline docs related to plugin and theme auto-updates.

See #50052, #49572

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

Legend:

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

    r48071 r48097  
    871871     * @since 5.5.0
    872872     *
    873      * @param object $results The result of updates tasks.
     873     * @param array $update_results The result of updates tasks.
    874874     */
    875875    protected function after_plugin_theme_update( $update_results ) {
     
    933933     * @since 5.5.0
    934934     *
    935      * @param string $type               The type of email to send. Can be one of 'success', 'failure', 'mixed'.
     935     * @param string $type               The type of email to send. Can be one of 'success', 'fail', 'mixed'.
    936936     * @param array  $successful_updates A list of updates that succeeded.
    937937     * @param array  $failed_updates     A list of updates that failed.
     
    10251025
    10261026        /**
    1027          * Filters the email sent following an automatic background plugin update.
     1027         * Filters the email sent following an automatic background update for plugins and themes.
    10281028         *
    10291029         * @since 5.5.0
    10301030         *
    1031          * @param array $email {
     1031         * @param array  $email {
    10321032         *     Array of email arguments that will be passed to wp_mail().
    10331033         *
     
    10401040         * @param string $type               The type of email being sent. Can be one of
    10411041         *                                   'success', 'fail', 'mixed'.
    1042          * @param object $successful_updates The updates that succeeded.
    1043          * @param object $failed_updates     The updates that failed.
     1042         * @param array $successful_updates The updates that succeeded.
     1043         * @param array $failed_updates     The updates that failed.
    10441044         */
    10451045        $email = apply_filters( 'auto_plugin_theme_update_email', $email, $type, $successful_updates, $failed_updates );
  • trunk/src/wp-admin/includes/update.php

    r47857 r48097  
    945945 * @since 5.5.0
    946946 *
    947  * @param string $type    The type of update being checked: 'theme' or 'plugin'.
     947 * @param string $type The type of update being checked: 'theme' or 'plugin'.
    948948 * @return bool True if auto-updates are enabled for `$type`, false otherwise.
    949949 */
     
    952952        case 'plugin':
    953953            /**
    954              * Filters whether plugins manual auto-update is enabled.
     954             * Filters whether plugins auto-update is enabled.
    955955             *
    956956             * @since 5.5.0
     
    961961        case 'theme':
    962962            /**
    963              * Filters whether plugins manual auto-update is enabled.
     963             * Filters whether themes auto-update is enabled.
    964964             *
    965965             * @since 5.5.0
    966966             *
    967              * @param bool True if themes auto-update is enabled, false otherwise.
     967             * @param bool $enabled True if themes auto-update is enabled, false otherwise.
    968968             */
    969969            return apply_filters( 'themes_auto_update_enabled', true );
     
    974974
    975975/**
    976  * Determines the appropriate update message to be displayed.
     976 * Determines the appropriate auto-update message to be displayed.
    977977 *
    978978 * @since 5.5.0
  • trunk/src/wp-admin/themes.php

    r48095 r48097  
    557557 * @since 5.5.0
    558558 *
    559  * @return string Template
     559 * @return string The template for displaying the auto-update setting link.
    560560 */
    561561function wp_theme_auto_update_setting_template() {
Note: See TracChangeset for help on using the changeset viewer.