Changeset 25699 for trunk/src/wp-includes/update.php

Timestamp:

10/06/2013 03:30:51 PM (12 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-includes/update.php.

Props ShinichiN.
Fixes #25467.

File:

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

trunk/src/wp-includes/update.php

@@ -43 +43 @@
         return false;
 
-    $locale = apply_filters( 'core_version_check_locale', get_locale() );
+    $locale = get_locale();
+    /**
+     * Filter the locale requested for WordPress core translations.
+     *
+     * @since 2.8.0
+     *
+     * @param string $locale Current locale.
+     */
+    $locale = apply_filters( 'core_version_check_locale', $locale );
 
     // Update last_checked for current to prevent multiple blocking requests if request hangs
@@ -213 +221 @@
     $to_send = compact( 'plugins', 'active' );
 
+    $locales = array( get_locale() );
     /**
      * Filter the locales requested for plugin translations.
@@ -218 +227 @@
      * @since 3.7.0
      *
-     * @param array $locales Defaults to the current locale of the site.
+     * @param array $locales Plugin locale. Default is current locale of the site.
      */
-    $locales = apply_filters( 'plugins_update_check_locales', array( get_locale() ) );
+    $locales = apply_filters( 'plugins_update_check_locales', $locales );
 
     $options = array(
@@ -348 +357 @@
     $request['themes'] = $themes;
 
+    $locales = array( get_locale() );
     /**
      * Filter the locales requested for theme translations.
@@ -353 +363 @@
      * @since 3.7.0
      *
-     * @param array $locales Defaults to the current locale of the site.
+     * @param array $locales Theme locale. Default is current locale of the site.
      */
-    $locales = apply_filters( 'themes_update_check_locales', array( get_locale() ) );
+    $locales = apply_filters( 'themes_update_check_locales', $locales );
 
     $options = array(
@@ -444 +454 @@
     $update_title = $titles ? esc_attr( implode( ', ', $titles ) ) : '';
 
-    return apply_filters( 'wp_get_update_data', array( 'counts' => $counts, 'title' => $update_title ), $titles );
+    $update_data = array( 'counts' => $counts, 'title' => $update_title );
+    /**
+     * Filter the returned array of update data for plugins, themes, and WordPress core.
+     *
+     * @since 3.5.0
+     *
+     * @param array $update_data {
+     *     Fetched update data.
+     *
+     *     @type array   $counts       An array of counts for available plugin, theme, and WordPress updates.
+     *     @type string  $update_title Titles of available updates.
+     * }
+     * @param array $titles An array of update counts and UI strings for available updates.
+     */
+    return apply_filters( 'wp_get_update_data', $update_data, $titles );
 }