CODEWITHSUNDEEP
wordpresswordpress-rest-api
Xiao Xinqi
Xiao Xinqi

Reputation: 521

wordpress rest api v2 how to list taxonomy terms?

i am new to v2, i use v1 for long time, currently upgrade to v2, i try to get all the terms belong to specific custom taxonomy.

In v1 i can do this to get terms /taxonomies/location_category/terms

but in v2 i try /taxonomies/terms it return json error "code":"rest_no_route","message":"No route was found matching the URL and request method","data":{"status" :404}}

if just /taxonomies/location_category/ it didn't show anything terms belong to taxonomy.

i search the question on google for few hours didn't show any result, anyone can help please, thank you

Upvotes: 7

Views: 22014

Answers (7)

Philipp
Philipp

Reputation: 11361

TLDR

Use the flag show_in_rest when you register the taxonomy. That's all.

Details

List all available taxonomies

All default taxonomies are available via REST API. Use the following endpoint to get a list of all available taxonomies:

https://exmaple.org/wp-json/wp/v2/taxonomies

It will tell you the correct endpoint for each taxonomy in the wp:items tag, e.g.

..., "wp:items":[{"href":"https://example.com/wp-json/wp/v2/categories"}], ...
..., "wp:items":[{"href":"https://example.com/wp-json/wp/v2/tags"}], ...

Adding new taxonomies to the REST endpoint

In case your taxonomy is not listed in this taxonomy overview, you need to enable the REST endpoint when calling register_taxonomy. You can do this by adding the argument 'show_in_rest' => true:

<php
register_taxonomy( 'location_category', 'post', [
    // ...
    'show_in_rest' => true, // ← make sure you have this line in the taxonomy args!
] );

Note: If you do NOT use show_in_rest, then the taxonomy is not available in the Block Editor ("Gutenberg").

I strongly advise against creating custom REST endpoints to duplicate built-in logic.
I.e. don't do this or this

Upvotes: 5

Rajilesh Panoli
Rajilesh Panoli

Reputation: 790

Seems some confusion for some devs even for me.

Correct URL is https://example.com/wp-json/wp/v2/{your_taxonomy}

Not https://example.com/wp-json/wp/v2/taxonomies/{your_taxonomy}

"/taxonomies" not required

Upvotes: 1

Marty McGee
Marty McGee

Reputation: 774

Taxonomy terms are simply called this way:

https://yoursite.com/wp-json/wp/v2/the-taxonomy-slug

For instance, to answer your question:

https://yoursite.com/wp-json/wp/v2/location_category

From terminal:

curl -X GET -i http://www.example.com/wp-json/wp/v2/location_category

Upvotes: 15

hyp0thetical
hyp0thetical

Reputation: 300

If anyone is reading this in the future, I ran into an issue where the default WP category was outputting a parent key of 0, 1, 2 etc for each term object, which is a problem in itself, but a bigger problem when custom taxonomies do not have this parent value on objects

To solve this amend the ticked example with this: 

    foreach ($taxonomies as $key => $taxonomy_name) {
        if($taxonomy_name = $_GET['term']){
            $return = get_terms( array( 
                'taxonomy' => $taxonomy_name,
                'hide_empty' => false,
            ));
        }
    }

Upvotes: 0

Harry Moreno
Harry Moreno

Reputation: 11603

The accepted answer mostly worked for me. This is what I got

<?php
// your_theme/functions.php
/**
 * how to list all taxonomy terms
 */
class all_terms
{   
    public function __construct()
    {   
        $version = '2';
        $namespace = 'wp/v' . $version;
        $base = 'all-terms';
        register_rest_route($namespace, '/' . $base, array(
            'methods' => 'GET',
            'callback' => array($this, 'get_all_terms'),
        )); 
    }   
    public function get_all_terms($object)
    {   
        $args = array(
            'public' => true,
            '_builtin' => false
        );  
        $output = 'names'; // or objects
        $operator = 'and'; // 'and' or 'or' 
        $taxonomies = get_taxonomies($args, $output, $operator);
        foreach ($taxonomies as $key => $taxonomy_name) {
            if ($taxonomy_name = $_GET['term']) {
                $return[] = get_terms(array(
                    'taxonomy' => $taxonomy_name,
                    'hide_empty' => false,
                )); 
            }   
        }   
        return new WP_REST_Response($return, 200);
    }   
}
add_action( 'rest_api_init', get_all_terms);
?>

matches the docs more closely https://developer.wordpress.org/reference/functions/get_terms/

Upvotes: 0

Xiao Xinqi
Xiao Xinqi

Reputation: 521

end out to write the custom code here

add blow code to functions.php

  class all_terms
{
    public function __construct()
    {
        $version = '2';
        $namespace = 'wp/v' . $version;
        $base = 'all-terms';
        register_rest_route($namespace, '/' . $base, array(
            'methods' => 'GET',
            'callback' => array($this, 'get_all_terms'),
        ));
    }

    public function get_all_terms($object)
    {
        $return = array();
        // $return['categories'] = get_terms('category');
 //        $return['tags'] = get_terms('post_tag');
        // Get taxonomies
        $args = array(
            'public' => true,
            '_builtin' => false
        );
        $output = 'names'; // or objects
        $operator = 'and'; // 'and' or 'or'
        $taxonomies = get_taxonomies($args, $output, $operator);
        foreach ($taxonomies as $key => $taxonomy_name) {
            if($taxonomy_name = $_GET['term']){
            $return = get_terms($taxonomy_name);
        }
        }
        return new WP_REST_Response($return, 200);
    }
}

add_action('rest_api_init', function () {
    $all_terms = new all_terms;
});

and enter url http://youdomain.com/wp-json/wp/v2/all-terms?term=you_taxonomy

so term = you_taxonomy, will get terms belong to job_category.

Upvotes: 15

Steve Grunwell
Steve Grunwell

Reputation: 896

For custom taxonomies, be sure that you're setting the 'show_in_rest' argument to be true (default is false) in your register_taxonomy() call.

The register_taxonomy() call is also where you can set the 'rest_base' argument (default will be the taxonomy name, /location_category/ in your example).

Upvotes: 6

Related Questions