Retrieves a list of category objects.
CONTENTS
Description Description
If you set the ‘taxonomy’ argument to ‘link_category’, the link categories will be returned instead.
See also See also
- get_terms(): Type of arguments that can be changed.
Parameters Parameters
- $args
-
(string|array) (Optional) Arguments to retrieve categories. See get_terms() for additional options.
- ‘taxonomy’
(string) Taxonomy to retrieve terms for. Default ‘category’.
Default value: ”
- ‘taxonomy’
Return Return
(array) List of category objects.
Source Source
File: wp-includes/category.php
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
function get_categories( $args = '' ) { $defaults = array ( 'taxonomy' => 'category' ); $args = wp_parse_args( $args , $defaults ); /** * Filters the taxonomy used to retrieve terms when calling get_categories(). * * @since 2.7.0 * * @param string $taxonomy Taxonomy to retrieve terms from. * @param array $args An array of arguments. See get_terms(). */ $args [ 'taxonomy' ] = apply_filters( 'get_categories_taxonomy' , $args [ 'taxonomy' ], $args ); // Back compat. if ( isset( $args [ 'type' ] ) && 'link' === $args [ 'type' ] ) { _deprecated_argument( __FUNCTION__ , '3.0.0' , sprintf( /* translators: 1: "type => link", 2: "taxonomy => link_category" */ __( '%1$s is deprecated. Use %2$s instead.' ), '<code>type => link</code>' , '<code>taxonomy => link_category</code>' ) ); $args [ 'taxonomy' ] = 'link_category' ; } $categories = get_terms( $args ); if ( is_wp_error( $categories ) ) { $categories = array (); } else { $categories = ( array ) $categories ; foreach ( array_keys ( $categories ) as $k ) { _make_cat_compat( $categories [ $k ] ); } } return $categories ; } |
Changelog Changelog
Version | Description |
---|---|
2.1.0 | Introduced. |