Skip to content

Latest commit

 

History

History
143 lines (106 loc) · 4.41 KB

taxonomy.md

File metadata and controls

143 lines (106 loc) · 4.41 KB
Raw

Taxonomy

Basic usage

The Taxonomy class, as the name suggests, helps you register WordPress custom taxonomies.

In order to register a custom taxonomy, you may call the make and set methods of the Taxonomy class.

For example, let's register a custom taxonomy in order to handle a list of authors for our books custom post type from previous examples. The custom taxonomy will have a slug of authors:

use Themosis\Support\Facades\Taxonomy;

Taxonomy::make('authors', 'books', 'Authors', 'Author')
    ->set();

Note: the custom taxonomy is only registered when you call the set() method and is automatically bound to attached objects.

Labels

The make() method needs a plural and singular display names as third and fourth parameters. Those parameters will pre-fill the labels property of your custom taxonomy.

Taxonomy::make('authors', 'books', 'Authors', 'Author')->set();

In the above code sample, the custom taxonomy will have a plural display name of Authors and a singular display name of Author.

If you need to define the taxonomy labels, you can override the default taxonomy labels by calling the setLabels method on your taxonomy instance like so:

Taxonomy::make('authors', 'books', 'Authors', 'Author')
    ->setLabels([
        'edit_item' => 'Edit Me'
    ])
    ->set();

See the get_taxonomy_labels() function for a full list of available labels.

Customize your taxonomy

In order to define the behavior of your custom taxonomy, use the setArguments() method and pass it an array of parameters like so:

Taxonomy::make('authors', 'books', 'Authors', 'Author')
    ->setArguments([
        'public' => true,
        'show_in_nav_menus'  => false,
        'hierarchical' => true,
        'show_tagcloud' => false,
        'show_in_quick_edit' => false
    ])
    ->set();

Shared taxonomies

You can define a taxonomy that can be shared between multiple post types by passing an array of post type names like so:

Taxonomy::make('authors', ['post', 'books'], 'Authors', 'Author')->set();

The above code register an authors taxonomy for both post and books post types.

Term fields

Using the TaxonomyField facade class, it is possible to define custom fields for taxonomy terms. In order to attach custom fields to taxonomy terms, first call the make method of the TaxonomyField facade and pass it as a first argument a taxonomy instance:

use Themosis\Support\Facades\Taxonomy;
use Themosis\Support\Facades\TaxonomyField;

$author = Taxonomy::make('author', 'post', 'Authors', 'Author')
    ->set();
    
TaxonomyField::make($author)
    ->set();

See the use of the set method call in order to register the taxonomy fields. Fields are only displayed if the set method is called.

Add custom fields

In order to add custom fields to your taxonomy, you may call the add method and pass it a field instance like so:

use Themosis\Support\Facades\Field;

TaxonomyField::make($author)
    ->add(Field::text('publisher'))
    ->set();

You can chain multiple calls of the add method in order to define all your taxonomy terms fields:

TaxonomyField::make($author)
    ->add(Field::text('publisher'))
    ->add(Field::text('website'))
    ->add(Field::choice('genre', [
        'choices' => [
            'Comedy',
            'Fantasy',
            'Science-Fiction',
            'Thriller'
        ]
    ]))
    ->add(Field::textarea('note'))
    ->set();

Validation

The term fields leverage the illuminate/validation package for their validation. Simply define a rules option to each field. If a validation fails, the default term data used by WordPress is still stored.

TaxonomyField::make()
    ->add(Field::text('publisher', [
        'rules' => 'min:6'
    ]))
    ->add(Field::text('website', [
        'rules' => 'url'
    ]))
    ->set();

For more information about each field options, please see the field guide.