Changeset 46891 for trunk/src/wp-includes/category.php

Timestamp:

12/12/2019 04:45:32 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update description for get_categories() to avoid suggesting the deprecated type argument.

Follow-up to [13754].

Props dingo_d.
Fixes #48913.

File:

• trunk/src/wp-includes/category.php (modified) (4 diffs)

trunk/src/wp-includes/category.php

@@ -10 +10 @@
  * Retrieve list of category objects.
  *
- * If you change the type to 'link' in the arguments, then the link categories
- * will be returned instead. Also all categories will be updated to be backward
- * compatible with pre-2.3 plugins and themes.
+ * If you set the 'taxonomy' argument to 'link_category', the link categories
+ * will be returned instead.
  *
  * @since 2.1.0
@@ -20 +19 @@
  *     Optional. Arguments to retrieve categories. See get_terms() for additional options.
  *
- *     @type string $taxonomy Taxonomy to retrieve terms for. In this case, default 'category'.
+ *     @type string $taxonomy Taxonomy to retrieve terms for. Default 'category'.
  * }
- * @return array List of categories.
+ * @return array List of category objects.
  */
 function get_categories( $args = '' ) {
@@ -79 +78 @@
  * filters and finally sanitized based on the $filter parameter value.
  *
- * The category will converted to maintain backward compatibility.
- *
  * @since 1.5.1
  *
@@ -337 +334 @@
 
 /**
- * Update category structure to old pre 2.3 from new taxonomy structure.
+ * Update category structure to old pre-2.3 from new taxonomy structure.
  *
  * This function was added for the taxonomy support to update the new category