Changeset 32654 for trunk/src/wp-admin/includes/update.php

Timestamp:

05/29/2015 08:16:22 PM (10 years ago)

Author:

wonderboymusic

Message:

Add missing doc blocks to wp-admin/includes/*.
Fix some egregious uses of tabbing.
Some functions can simply return apply_filters(...) instead of setting a variable that is immediately returned.

See #32444.

File:

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

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

@@ -10 +10 @@
  * Selects the first update version from the update_core option.
  *
- * @return bool|object The response from the API on success, false on failure.
+ * @return object|array|false The response from the API on success, false on failure.
  */
 function get_preferred_from_update_core() {
@@ -25 +25 @@
  *
  * @param array $options Set $options['dismissed'] to true to show dismissed upgrades too,
- *  set $options['available'] to false to skip not-dismissed updates.
- * @return bool|array Array of the update objects on success, false on failure.
+ *                       set $options['available'] to false to skip not-dismissed updates.
+ * @return array|false Array of the update objects on success, false on failure.
  */
 function get_core_updates( $options = array() ) {
@@ -68 +68 @@
  * @since 3.7.0
  *
- * @return bool|array False on failure, otherwise the core update offering.
+ * @return array|false False on failure, otherwise the core update offering.
  */
 function find_core_auto_update() {
@@ -129 +129 @@
 }
 
+/**
+ *
+ * @param object $update
+ * @return bool
+ */
 function dismiss_core_update( $update ) {
     $dismissed = get_site_option( 'dismissed_update_core' );
@@ -135 +140 @@
 }
 
+/**
+ *
+ * @param string $version
+ * @param string $locale
+ * @return bool
+ */
 function undismiss_core_update( $version, $locale ) {
     $dismissed = get_site_option( 'dismissed_update_core' );
@@ -146 +157 @@
 }
 
+/**
+ *
+ * @param string $version
+ * @param string $locale
+ * @return object|false
+ */
 function find_core_update( $version, $locale ) {
     $from_api = get_site_transient( 'update_core' );
@@ -160 +177 @@
 }
 
+/**
+ *
+ * @param string $msg
+ * @return string
+ */
 function core_update_footer( $msg = '' ) {
     if ( !current_user_can('update_core') )
@@ -265 +287 @@
 }
 
+/**
+ *
+ * @param string $file
+ * @param array  $plugin_data
+ * @return false|void
+ */
 function wp_plugin_update_row( $file, $plugin_data ) {
     $current = get_site_transient( 'update_plugins' );
@@ -331 +359 @@
 }
 
+/**
+ *
+ * @return array
+ */
 function get_theme_updates() {
     $current = get_site_transient('update_themes');
@@ -360 +392 @@
 }
 
+/**
+ *
+ * @param string   $theme_key
+ * @param WP_Theme $theme
+ * @return false|void
+ */
 function wp_theme_update_row( $theme_key, $theme ) {
     $current = get_site_transient( 'update_themes' );