Changeset 31638

Timestamp:

03/06/2015 08:04:32 AM (11 years ago)

Author:

DrewAPicture

Message:

Correct the $number argument description in get_terms() to reflect that an empty string or 0 will return all possible results, not -1.

Previously, it was noted that -1 would return all possible results. However, as the value of $number is passed through absint(), -1 would actually be converted to 1, thereby producing unexpected results.

Props iandunn.
Fixes #31526.

File:

• trunk/src/wp-includes/taxonomy.php (modified) (1 diff)

trunk/src/wp-includes/taxonomy.php

@@ -1592 +1592 @@
  *                                           along with all of their descendant terms. If $include is
  *                                           non-empty, $exclude_tree is ignored. Default empty array.
- *     @type int          $number            Maximum number of terms to return. Accepts 1+ or -1 (all).
- *                                           Default -1.
+ *     @type int|string   $number            Maximum number of terms to return. Accepts ''|0 (all) or any
+ *                                           positive number. Default ''|0 (all).
+ *                                           Default ''|0 (all).
  *     @type int          $offset            The number by which to offset the terms query. Default empty.
  *     @type string       $fields            Term fields to query for. Accepts 'all' (returns an array of