Changeset 33904

Timestamp:

09/04/2015 09:24:04 PM (9 years ago)

Author:

boonebgorges

Message:

Allow wp_terms_checklist() to return markup rather than echoing it.

Props kevinlangleyjr.
Fixes #33720.

File:

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

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

@@ -165 +165 @@
  *
  * @since 3.0.0
+ * @since 4.4.0 Introduced the `$echo` argument.
  *
  * @param int          $post_id Optional. Post ID. Default 0.
@@ -180 +181 @@
  *     @type bool   $checked_ontop        Whether to move checked items out of the hierarchy and to
  *                                        the top of the list. Default true.
+ *     @type bool   $echo                 Whether to echo the generated markup. False to return the markup instead
+ *                                        of echoing it. Default true.
  * }
  */
@@ -189 +192 @@
         'walker' => null,
         'taxonomy' => 'category',
-        'checked_ontop' => true
+        'checked_ontop' => true,
+        'echo' => true,
     );
 
@@ -252 +256 @@
     }
 
+    $output = '';
+
     if ( $r['checked_ontop'] ) {
         // Post process $categories rather than adding an exclude to the get_terms() query to keep the query the same across all posts (for any query cache)
@@ -265 +271 @@
 
         // Put checked cats on top
-        echo call_user_func_array( array( $walker, 'walk' ), array( $checked_categories, 0, $args ) );
+        $output .= call_user_func_array( array( $walker, 'walk' ), array( $checked_categories, 0, $args ) );
     }
     // Then the rest of them
-    echo call_user_func_array( array( $walker, 'walk' ), array( $categories, 0, $args ) );
+    $output .= call_user_func_array( array( $walker, 'walk' ), array( $categories, 0, $args ) );
+
+    if ( $r['echo'] ) {
+        echo $output;
+    }
+
+    return $output;
 }