wp-kit/registry

A wp-kit component that handles Post Type and Taxonomy registration

wp-kit/registry

This is a wp-kit component that handles PostType and Taxonomy registration., _(*1)

This component was built to run within an Illuminate\Container\Container so is perfect for frameworks such as Themosis, Assely and wp-kit/theme., _(*2)

wp-kit/registry is fully comptaible with Themosis and if you are using Themosis you'll notice it already has a PostTypeBuilder and a TaxonomyBuilder but wp-kit/registry just simplifies the process by providing an OOP approach to registering PostTypes and Taxonomies., _(*3)

Installation

If you're using Themosis, install via Composer in the Themosis route folder, otherwise install in your Composer driven theme folder:, _(*4)

composer require "wp-kit/registry"

Setup

Add Service Provider

Just register the service provider and facade in the providers config and theme config:, _(*5)

//inside theme/resources/config/providers.config.php

return [
    //
    WPKit\Registry\RegistryServiceProvider::class,
    //
];

Add PRS4 Class Reference (Themosis Only)

Just add the following line to resources/config/loading.config.php in the Themosis theme folder:, _(*6)

'Theme\\Taxonomies\\' => themosis_path('theme.resources').'taxonomies',
'Theme\\PostTypes\\' => themosis_path('theme.resources').'postTypes',

Add Config & View File

The recommended method of installing config files for wp-kit components is via wp kit vendor:publish command., _(*7)

First, install WP CLI, and then install this component, wp kit vendor:publish will automatically be installed with wp-kit/utils, once installed you can run:, _(*8)

wp kit vendor:publish, _(*9)

For more information, please visit wp-kit/utils., _(*10)

Alternatively, you can place the config file(s), post type file(s) and taxonomy file(s) in your theme/resources/config, theme/resources/postTypes and theme/resources/taxonomies directories manually., _(*11)

Usage

Adding Classes

wp-kit\registry comes with two classes that can extended, WPKit\Registry\PostType and WPKit\Registry\Taxonomy., _(*12)

Any custom PostTypes and Taxonomies should be added inside resources/shortcodes within the namespace Theme\PostType or Theme\Taxonomy., _(*13)

Here is an example PostType class., _(*14)

Here is an example Taxonomy class., _(*15)

Get Involved

To learn more about how to use wp-kit check out the docs:, _(*16)

View the Docs, _(*17)

Any help is appreciated. The project is open-source and we encourage you to participate. You can contribute to the project in multiple ways by:, _(*18)

• Reporting a bug issue
• Suggesting features
• Sending a pull request with code fix or feature
• Following the project on GitHub
• Sharing the project around your community

For details about contributing to the framework, please check the contribution guide., _(*19)

Requirements

Wordpress 4+, _(*20)

PHP 5.6+, _(*21)

License

wp-kit/registry is open-sourced software licensed under the MIT License., _(*22)