Changeset 12658

Timestamp:

01/08/2010 08:44:45 AM (15 years ago)

Author:

westi

Message:

Add support to get_terms() to allow 'include' & 'exclude' args to be arrays(). Fixes #11076 props scribu.

Location:

trunk/wp-includes

Files:

• functions.php (modified) (1 diff)
• taxonomy.php (modified) (6 diffs)

trunk/wp-includes/functions.php

@@ -2751 +2751 @@
 
 /**
+ * Clean up an array, comma- or space-separated list of IDs
+ *
+ * @since 3.0.0
+ *
+ * @param array|string $list
+ * @return array Sanitized array of IDs
+ */
+function wp_parse_id_list($list) {
+    if ( !is_array($list) )
+        $list = preg_split('/[\s,]+/', $list);
+
+    return array_unique(array_map('absint', $list));
+}
+
+/**
  * Determines if default embed handlers should be loaded.
  *

trunk/wp-includes/taxonomy.php

@@ -572 +572 @@
  * terms whose count is 0 according to the given taxonomy.
  *
- * exclude - Default is an empty string.  A comma- or space-delimited string
+ * exclude - Default is an empty array.  An array, comma- or space-delimited string
  * of term ids to exclude from the return array.  If 'include' is non-empty,
  * 'exclude' is ignored.
  *
- * exclude_tree - A comma- or space-delimited string of term ids to exclude
- * from the return array, along with all of their descendant terms according to
- * the primary taxonomy.  If 'include' is non-empty, 'exclude_tree' is ignored.
- *
- * include - Default is an empty string.  A comma- or space-delimited string
+ * exclude_tree - Default is an empty array.  An array, comma- or space-delimited 
+ * string of term ids to exclude from the return array, along with all of their 
+ * descendant terms according to the primary taxonomy.  If 'include' is non-empty, 
+ * 'exclude_tree' is ignored.
+ *
+ * include - Default is an empty array.  An array, comma- or space-delimited string
  * of term ids to include in the return array.
  *
- * number - The maximum number of terms to return.  Default is empty.
+ * number - The maximum number of terms to return.  Default is to return them all.
  *
  * offset - The number by which to offset the terms query.
@@ -652 +653 @@
 
     $defaults = array('orderby' => 'name', 'order' => 'ASC',
-        'hide_empty' => true, 'exclude' => '', 'exclude_tree' => '', 'include' => '',
+        'hide_empty' => true, 'exclude' => array(), 'exclude_tree' => array(), 'include' => array(),
         'number' => '', 'fields' => 'all', 'slug' => '', 'parent' => '',
         'hierarchical' => true, 'child_of' => 0, 'get' => '', 'name__like' => '',
@@ -720 +721 @@
         $exclude = '';
         $exclude_tree = '';
-        $interms = preg_split('/[\s,]+/',$include);
-        if ( count($interms) ) {
-            foreach ( (array) $interms as $interm ) {
-                if (empty($inclusions))
-                    $inclusions = ' AND ( t.term_id = ' . intval($interm) . ' ';
-                else
-                    $inclusions .= ' OR t.term_id = ' . intval($interm) . ' ';
-            }
+        $interms = wp_parse_id_list($include);
+        foreach ( $interms as $interm ) {
+            if ( empty($inclusions) )
+                $inclusions = ' AND ( t.term_id = ' . intval($interm) . ' ';
+            else
+                $inclusions .= ' OR t.term_id = ' . intval($interm) . ' ';
         }
     }
@@ -736 +735 @@
 
     $exclusions = '';
-    if ( ! empty( $exclude_tree ) ) {
-        $excluded_trunks = preg_split('/[\s,]+/',$exclude_tree);
-        foreach( (array) $excluded_trunks as $extrunk ) {
+    if ( !empty( $exclude_tree ) ) {
+        $excluded_trunks = wp_parse_id_list($exclude_tree);
+        foreach ( $excluded_trunks as $extrunk ) {
             $excluded_children = (array) get_terms($taxonomies[0], array('child_of' => intval($extrunk), 'fields' => 'ids'));
             $excluded_children[] = $extrunk;
-            foreach( (array) $excluded_children as $exterm ) {
-                if ( empty($exclusions) )
-                    $exclusions = ' AND ( t.term_id <> ' . intval($exterm) . ' ';
-                else
-                    $exclusions .= ' AND t.term_id <> ' . intval($exterm) . ' ';
-
-            }
-        }
-    }
-    if ( !empty($exclude) ) {
-        $exterms = preg_split('/[\s,]+/',$exclude);
-        if ( count($exterms) ) {
-            foreach ( (array) $exterms as $exterm ) {
+            foreach( $excluded_children as $exterm ) {
                 if ( empty($exclusions) )
                     $exclusions = ' AND ( t.term_id <> ' . intval($exterm) . ' ';
@@ -759 +746 @@
                     $exclusions .= ' AND t.term_id <> ' . intval($exterm) . ' ';
             }
+        }
+    }
+
+    if ( !empty($exclude) ) {
+        $exterms = wp_parse_id_list($exclude);
+        foreach ( $exterms as $exterm ) {
+            if ( empty($exclusions) )
+                $exclusions = ' AND ( t.term_id <> ' . intval($exterm) . ' ';
+            else
+                $exclusions .= ' AND t.term_id <> ' . intval($exterm) . ' ';
         }
     }
@@ -835 +832 @@
             if ( ! $term->count ) {
                 $children = _get_term_children($term->term_id, $terms, $taxonomies[0]);
-                if( is_array($children) )
+                if ( is_array($children) )
                     foreach ( $children as $child )
                         if ( $child->count )