README

Requirements

PHP >= 8.0
WordPress >= 6.7
Roots Bedrock >= 1.26
Roots Acorn >= 4.3

Installation

You can install this package with Composer:

composer require concept-image/wp-custom-post-types

Usage

This package provides a convenient way to create and manage custom post types and taxonomies in WordPress using a structured approach. It leverages the power of Roots Bedrock and Acorn to integrate seamlessly into your WordPress project.

Custom Post Types

To create a custom post type, you need to define a class in the app/CustomPostTypes directory. The class should have a name property and a getArgs method that returns the arguments for the custom post type registration.

Example:

namespace App\CustomPostTypes;

class Book
{
    public $name = 'book';

    public function getArgs(): array
    {
        return [
            'label' => 'Books',
            'public' => true,
            'supports' => ['title', 'editor', 'thumbnail'],
            'taxonomies' => ['genre'],
        ];
    }
}

Taxonomies

To create a custom taxonomy, you need to define a class in the app/Taxonomies directory. The class should have a name property, an object_type property, and a getArgs method that returns the arguments for the taxonomy registration.

Example:

namespace App\Taxonomies;

class Genre
{
    public $name = 'genre';
    public $object_type = ['book'];

    public function getArgs(): array
    {
        return [
            'label' => 'Genres',
            'public' => true,
            'hierarchical' => true,
        ];
    }
}

Registering Custom Post Types and Taxonomies

The package automatically registers custom post types and taxonomies defined in the app/CustomPostTypes and app/Taxonomies directories, respectively. You don't need to manually register them in your theme or plugin.

Changelog

Please refer to CHANGELOG for more information.

Contributing

Please refer to CONTRIBUTING for more information.

License

Please refer to LICENSE for more information.

concept-image / wp-custom-post-types

Maintainers

Details