Changeset 27264

Timestamp:

02/25/2014 05:19:22 PM (11 years ago)

Author:

nacin

Message:

Clarify return values for get_preferred_from_update_core() and get_core_updates().

props SergeyBiryukov.
fixes #20251.

File:

• trunk/src/wp-admin/includes/update.php (modified) (2 diffs)

trunk/src/wp-admin/includes/update.php

@@ -8 +8 @@
 
 /**
- * Selects the first update version from the update_core option
- *
- * @return object the response from the API
+ * Selects the first update version from the update_core option.
+ *
+ * @return bool|object The response from the API on success, false on failure.
  */
 function get_preferred_from_update_core() {
@@ -22 +22 @@
 
 /**
- * Get available core updates
+ * Get available core updates.
  *
  * @param array $options Set $options['dismissed'] to true to show dismissed upgrades too,
  *  set $options['available'] to false to skip not-dismissed updates.
- * @return array Array of the update objects
+ * @return bool|array Array of the update objects on success, false on failure.
  */
 function get_core_updates( $options = array() ) {