Changeset 29018 for trunk/src/wp-admin/includes/upgrade.php

Timestamp:

07/07/2014 09:48:50 PM (10 years ago)

Author:

nacin

Message:

Language on install: Docs and naming cleanups. see #28577.

File:

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

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

@@ -2160 +2160 @@
 endif;
 
-function wp_install_language_form( $body ) {
+function wp_install_language_form( $languages ) {
     echo "<fieldset>\n";
     echo "<legend class='screen-reader-text'>Select a default language</legend>\n";
@@ -2168 +2168 @@
 
     if ( defined( 'WPLANG' ) && ( '' !== WPLANG ) && ( 'en_US' !== WPLANG ) ) {
-        if ( isset( $body['languages'][WPLANG] ) ) {
-            $language = $body['languages'][WPLANG];
+        if ( isset( $languages[ WPLANG ] ) ) {
+            $language = $languages[ WPLANG ];
             echo '<input type="radio" name="language" checked="checked" class="' . esc_attr( $language['language'] ) . ' screen-reader-input" id="language_wplang" value="' . esc_attr( $language['language'] ) . '">';
             echo '<label for="language_wplang">' . esc_html( $language['native_name'] ) . "</label>\n";
@@ -2175 +2175 @@
     }
 
-    foreach ( $body['languages'] as $language ) {
+    foreach ( $languages as $language ) {
         echo '<input type="radio" name="language" class="' . esc_attr( $language['language'] ) . ' screen-reader-input" id="language_'. esc_attr( $language['language'] ) .'" value="' . esc_attr( $language['language'] ) . '">';
         echo '<label for="language_' . esc_attr( $language['language'] ) . '">' . esc_html( $language['native_name'] ) . "</label>\n";
@@ -2184 +2184 @@
 
 /**
- * @todo rename, move
- */
-function wp_get_available_translations() {
+ * Gets available translations from the WordPress.org API.
+ *
+ * @since 4.0.0
+ *
+ * @return array Array of translations, each an array of data.
+ */
+function wp_get_available_translations_from_api() {
     $url = 'http://api.wordpress.org/translations/core/1.0/';
     if ( wp_http_supports( array( 'ssl' ) ) ) {
@@ -2200 +2204 @@
     $body = wp_remote_retrieve_body( $response );
     if ( $body && $body = json_decode( $body, true ) ) {
-        $languages = array();
-        // Key the language array with the language code
-        foreach ( $body['languages'] as $language ) {
-            $languages[$language['language']] = $language;
-        }
-        $body['languages'] = $languages;
-        return $body;
+        $translations = array();
+        // Key the array with the language code for now
+        foreach ( $body['translations'] as $translation ) {
+            $translations[ $translation['language'] ] = $translation;
+        }
+        return $translations;
     }
     return false;
@@ -2212 +2215 @@
 
 /**
- * [wp_install_download_language_pack description]
- * 
- * @param  string $lang [description]
- * @return string|false [description]
- */
-function wp_install_download_language_pack( $lang ) {
-    // Check if the language is already installed.
-    $available_languages = get_available_languages();
-    if ( in_array( $lang, $available_languages ) ) {
-        return $lang;
-    }
-
-    // Confirm the language is one we can download.
-    $body = wp_get_available_translations();
-    $loading_language = false;
-    if ( $body ) {
-        foreach ( $body['languages'] as $language ) {
-            if ( $language['language'] === $lang ) {
-                $loading_language = $lang;
-                break;
-            }
-        }
-    }
-
-    if ( ! $loading_language ) {
+ * Downloads a language pack.
+ *
+ * @since 4.0.0
+ *
+ * @param string $download Language code to download.
+ * @return string|false Returns the language code if successfully downloaded
+ *                      (or already installed), or false on failure.
+ */
+function wp_install_download_language_pack( $download ) {
+    // Check if the translation is already installed.
+    if ( in_array( $download, get_available_languages() ) ) {
+        return $download;
+    }
+
+    // Confirm the translation is one we can download.
+    $translations = wp_get_available_translations_from_api();
+    if ( ! $translations ) {
         return false;
     }
-    $language = (object) $language;
+    foreach ( $translations as $translation ) {
+        if ( $translation['language'] === $download ) {
+            $translation_to_load = true;
+            break;
+        }
+    }
+
+    if ( empty( $translation_to_load ) ) {
+        return false;
+    }
+    $translation = (object) $translation;
 
     require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
     $skin = new Automatic_Upgrader_Skin;
     $upgrader = new Language_Pack_Upgrader( $skin );
-    $language->type = 'core';
+    $translation->type = 'core';
     /**
      * @todo failures (such as non-direct FS)
      */
-    $upgrader->upgrade( $language, array( 'clear_update_cache' => false ) );
-    return $language->language;
-}
-
-function wp_install_load_language( $request ) {
-    $loading_language = '';
-    if ( ! empty( $request ) ) {
-        $available_languages = get_available_languages();
-        if ( in_array( $request, $available_languages ) ) {
-            $loading_language = $request;
-        }
-    }
-
-    if ( $loading_language ) {
-        load_textdomain( 'default', WP_LANG_DIR . "/{$loading_language}.mo" );
-        load_textdomain( 'default', WP_LANG_DIR . "/admin-{$loading_language}.mo" );
-        return $loading_language;
-    }
-
-    return false;
-}
+    $upgrader->upgrade( $translation, array( 'clear_update_cache' => false ) );
+    return $translation->language;
+}
+
+/**
+ * Load a translation during the install process.
+ *
+ * @since 4.0.0
+ *
+ * @param string $translation Translation to load.
+ * @return string|false Returns the language code if successfully loaded,
+ *                      or false on failure.
+ */
+function wp_install_load_language( $translation ) {
+    if ( ! empty( $translation ) ) {
+        if ( in_array( $translation, get_available_languages() ) ) {
+            $translation_to_load = $translation;
+        }
+    }
+
+    if ( empty( $translation_to_load ) ) {
+        return false;
+    }
+
+    load_textdomain( 'default', WP_LANG_DIR . "/{$translation_to_load}.mo" );
+    load_textdomain( 'default', WP_LANG_DIR . "/admin-{$translation_to_load}.mo" );
+    return $translation_to_load;
+}