WordPress.org

Make WordPress Core

Changeset 49091


Ignore:
Timestamp:
10/05/2020 01:42:04 PM (9 months ago)
Author:
SergeyBiryukov
Message:

Docs: Add missing @return tag to Language_Pack_Upgrader::check_package().

Synchronize documentation of the ::check_package() method between Plugin_Upgrader, Theme_Upgrader, and Language_Pack_Upgrader.

Props ankitmaru, mukesh27, desrosj.
Fixes #51448.

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

Legend:

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

    r47808 r49091  
    310310
    311311    /**
    312      * Check the package source to make sure there are .mo and .po files.
     312     * Checks that the package source contains .mo and .po files.
    313313     *
    314314     * Hooked to the {@see 'upgrader_source_selection'} filter by
     
    317317     * @since 3.7.0
    318318     *
    319      * @global WP_Filesystem_Base $wp_filesystem Subclass
    320      *
    321      * @param string|WP_Error $source
    322      * @param string          $remote_source
     319     * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
     320     *
     321     * @param string|WP_Error $source        The path to the downloaded package source.
     322     * @param string          $remote_source Remote file source location.
     323     * @return string|WP_Error The source as passed, or a WP_Error object on failure.
    323324     */
    324325    public function check_package( $source, $remote_source ) {
  • trunk/src/wp-admin/includes/class-plugin-upgrader.php

    r48971 r49091  
    399399
    400400    /**
    401      * Check a source package to be sure it contains a plugin.
    402      *
    403      * This function is added to the {@see 'upgrader_source_selection'} filter by
    404      * Plugin_Upgrader::install().
     401     * Checks that the source package contains a valid plugin.
     402     *
     403     * Hooked to the {@see 'upgrader_source_selection'} filter by Plugin_Upgrader::install().
    405404     *
    406405     * @since 3.3.0
     
    410409     *
    411410     * @param string $source The path to the downloaded package source.
    412      * @return string|WP_Error The source as passed, or a WP_Error object
    413      *                         if no plugins were found.
     411     * @return string|WP_Error The source as passed, or a WP_Error object on failure.
    414412     */
    415413    public function check_package( $source ) {
  • trunk/src/wp-admin/includes/class-theme-upgrader.php

    r48971 r49091  
    511511
    512512    /**
    513      * Check that the package source contains a valid theme.
     513     * Checks that the package source contains a valid theme.
    514514     *
    515515     * Hooked to the {@see 'upgrader_source_selection'} filter by Theme_Upgrader::install().
    516      * It will return an error if the theme doesn't have style.css or index.php
    517      * files.
    518516     *
    519517     * @since 3.3.0
     
    522520     * @global string             $wp_version    The WordPress version string.
    523521     *
    524      * @param string $source The full path to the package source.
    525      * @return string|WP_Error The source or a WP_Error.
     522     * @param string $source The path to the downloaded package source.
     523     * @return string|WP_Error The source as passed, or a WP_Error object on failure.
    526524     */
    527525    public function check_package( $source ) {
Note: See TracChangeset for help on using the changeset viewer.