Changeset 55018

Timestamp:

12/27/2022 12:21:35 PM (22 months ago)

Author:

SergeyBiryukov

Message:

Docs: Remove the legacy example of passing a taxonomy to get_terms().

As of WordPress 4.5, taxonomies should be passed to get_terms() via the taxonomy argument in the $args array:

$terms = get_terms( array(
    'taxonomy'   => 'post_tag',
    'hide_empty' => false,
) );

The legacy way of passing a taxonomy via the function's first parameter was still mentioned in the documentation, causing some confusion.

This commit updates the function documentation to better highlight the currently recommended approach.

Follow-up to [36614].

Props ramon-fincken, sabernhardt, SergeyBiryukov.
Fixes #57380.

File:

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

trunk/src/wp-includes/taxonomy.php

@@ -1230 +1230 @@
  * along with the $args array.
  *
- * Prior to 4.5.0, the first parameter of `get_terms()` was a taxonomy or list of taxonomies:
- *
- *     $terms = get_terms( 'post_tag', array(
+ * Taxonomy or an array of taxonomies should be passed via the 'taxonomy' argument
+ * in the `$args` array:
+ *
+ *     $terms = get_terms( array(
+ *         'taxonomy'   => 'post_tag',
  *         'hide_empty' => false,
  *     ) );
  *
- * Since 4.5.0, taxonomies should be passed via the 'taxonomy' argument in the `$args` array:
- *
- *     $terms = get_terms( array(
- *         'taxonomy' => 'post_tag',
- *         'hide_empty' => false,
- *     ) );
+ * Prior to 4.5.0, taxonomy was passed as the first parameter of `get_terms()`.
  *
  * @since 2.3.0