Changeset 32510

Timestamp:

05/19/2015 12:32:10 AM (9 years ago)

Author:

SergeyBiryukov

Message:

Allow wp_dropdown_languages() to return the markup instead of displaying.

props leewillis77, juliobox.
fixes #32432.

File:

• trunk/src/wp-includes/l10n.php (modified) (5 diffs)

trunk/src/wp-includes/l10n.php

@@ -852 +852 @@
  *
  * @since 4.0.0
+ * @since 4.3.0 Introduced the `echo` argument.
  *
  * @see get_available_languages()
@@ -859 +860 @@
  *     Optional. Array or string of arguments for outputting the language selector.
  *
- *     @type string  $id                           ID attribute of the select element. Default empty.
- *     @type string  $name                         Name attribute of the select element. Default empty.
- *     @type array   $languages                    List of installed languages, contain only the locales.
- *                                                 Default empty array.
- *     @type array   $translations                 List of available translations. Default result of
- *                                                 {@see wp_get_available_translations()}.
- *     @type string  $selected                     Language which should be selected. Default empty.
- *     @type bool    $show_available_translations  Whether to show available translations. Default true.
+ *     @type string   $id                           ID attribute of the select element. Default empty.
+ *     @type string   $name                         Name attribute of the select element. Default empty.
+ *     @type array    $languages                    List of installed languages, contain only the locales.
+ *                                                  Default empty array.
+ *     @type array    $translations                 List of available translations. Default result of
+ *                                                  {@see wp_get_available_translations()}.
+ *     @type string   $selected                     Language which should be selected. Default empty.
+ *     @type bool|int $echo                         Whether to echo or return the generated markup. Accepts 0, 1, or their
+ *                                                  bool equivalents. Default 1.
+ *     @type bool     $show_available_translations  Whether to show available translations. Default true.
  * }
+ * @return string HTML content only if 'echo' argument is 0.
  */
 function wp_dropdown_languages( $args = array() ) {
@@ -877 +881 @@
         'translations' => array(),
         'selected'     => '',
+        'echo'         => 1,
         'show_available_translations' => true,
     ) );
@@ -913 +918 @@
     $translations_available = ( ! empty( $translations ) && $args['show_available_translations'] );
 
-    printf( '<select name="%s" id="%s">', esc_attr( $args['name'] ), esc_attr( $args['id'] ) );
+    $output = sprintf( '<select name="%s" id="%s">', esc_attr( $args['name'] ), esc_attr( $args['id'] ) );
 
     // Holds the HTML markup.
@@ -951 +956 @@
     }
 
-    echo join( "\n", $structure );
-
-    echo '</select>';
-}
+    $output .= join( "\n", $structure );
+
+    $output .= '</select>';
+
+    if ( $args['echo'] ) {
+        echo $output;
+    }
+
+    return $output;
+}