Changeset 49091 for trunk/src/wp-admin/includes/class-language-pack-upgrader.php

Timestamp:

10/05/2020 01:42:04 PM (4 years 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.

File:

• trunk/src/wp-admin/includes/class-language-pack-upgrader.php (modified) (2 diffs)

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

@@ -310 +310 @@
 
     /**
-     * Check the package source to make sure there are .mo and .po files.
+     * Checks that the package source contains .mo and .po files.
      *
      * Hooked to the {@see 'upgrader_source_selection'} filter by
@@ -317 +317 @@
      * @since 3.7.0
      *
-     * @global WP_Filesystem_Base $wp_filesystem Subclass
-     *
-     * @param string|WP_Error $source
-     * @param string          $remote_source
+     * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
+     *
+     * @param string|WP_Error $source        The path to the downloaded package source.
+     * @param string          $remote_source Remote file source location.
+     * @return string|WP_Error The source as passed, or a WP_Error object on failure.
      */
     public function check_package( $source, $remote_source ) {