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

Timestamp:

10/05/2020 01:42:04 PM (6 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-plugin-upgrader.php (modified) (2 diffs)

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

@@ -399 +399 @@
 
         /**
-         * Check a source package to be sure it contains a plugin.
-         *
-         * This function is added to the {@see 'upgrader_source_selection'} filter by
-         * Plugin_Upgrader::install().
+         * Checks that the source package contains a valid plugin.
+         *
+         * Hooked to the {@see 'upgrader_source_selection'} filter by Plugin_Upgrader::install().
          *
          * @since 3.3.0
@@ -410 +409 @@
          *
          * @param string $source The path to the downloaded package source.
-         * @return string|WP_Error The source as passed, or a WP_Error object
-         *                         if no plugins were found.
+         * @return string|WP_Error The source as passed, or a WP_Error object on failure.
          */
         public function check_package( $source ) {