Changeset 49061

Timestamp:

09/27/2020 08:34:51 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing @return tags for some WP_Automatic_Updater methods:

• ::is_vcs_checkout()
• ::should_update()
• ::send_core_update_notification_email()

Props ankitmaru, mukesh27.
Fixes #51385.

File:

• trunk/src/wp-admin/includes/class-wp-automatic-updater.php (modified) (5 diffs)

trunk/src/wp-admin/includes/class-wp-automatic-updater.php

@@ -63 +63 @@
      * checkout somewhere.
      *
-     * ABSPATH is always checked in addition to whatever $context is (which may be the
+     * ABSPATH is always checked in addition to whatever `$context` is (which may be the
      * wp-content directory, for example). The underlying assumption is that if you are
      * using version control *anywhere*, then you should be making decisions for
@@ -71 +71 @@
      *
      * @param string $context The filesystem path to check, in addition to ABSPATH.
+     * @return bool True if a VCS checkout was discovered at `$context` or ABSPATH,
+     *              or anywhere higher. False otherwise.
      */
     public function is_vcs_checkout( $context ) {
@@ -113 +115 @@
          * @since 3.7.0
          *
-         * @param bool $checkout  Whether a VCS checkout was discovered at $context
+         * @param bool $checkout  Whether a VCS checkout was discovered at `$context`
          *                        or ABSPATH, or anywhere higher.
          * @param string $context The filesystem context (a path) against which
@@ -133 +135 @@
      * @param string $context The filesystem context (a path) against which filesystem
      *                        access and status should be checked.
+     * @return bool True if the item should be updated, false otherwise.
      */
     public function should_update( $type, $item, $context ) {
@@ -243 +246 @@
      *
      * @param object $item The update offer.
+     * @return bool True if the site administrator is notified of a core update,
+     *              false otherwise.
      */
     protected function send_core_update_notification_email( $item ) {