Changeset 49091 for trunk/src/wp-admin/includes/class-theme-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-theme-upgrader.php (modified) (2 diffs)

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

@@ -511 +511 @@
 
     /**
-     * Check that the package source contains a valid theme.
+     * Checks that the package source contains a valid theme.
      *
      * Hooked to the {@see 'upgrader_source_selection'} filter by Theme_Upgrader::install().
-     * It will return an error if the theme doesn't have style.css or index.php
-     * files.
      *
      * @since 3.3.0
@@ -522 +520 @@
      * @global string             $wp_version    The WordPress version string.
      *
-     * @param string $source The full path to the package source.
-     * @return string|WP_Error The source or a WP_Error.
+     * @param string $source The path to the downloaded package source.
+     * @return string|WP_Error The source as passed, or a WP_Error object on failure.
      */
     public function check_package( $source ) {