carawebs/wp-custom-content

A library that generates WordPress custom post types and taxonomies from a config file.

Saturday, April 1, 2017
by DavidEgan
Repository
1 Watchers
0 Stars
19 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
0 Open issues
10 Versions
0 % Grown

The README.md

WP CPT

A WordPress plugin which registers:, _(*1)

Custom post types
Custom taxonomies

If you want to use this as a Composer package, rather than as a WordPress plugin, use the dev-library branch:, _(*2)

// composer.json for project
"carawebs/wp-custom-content": "dev-library"

I don't recommend this - the dev-library is a bit of an experiment in de-coupling custom post type registration from themes and plugins and is probably a step too far. CPT registration is probably best managed in either a plugin or mu-plugin). That branch does have quite an interesting method of loading, and a fluent interface to set the config file location., _(*3)

Usage

This plugin is designed for use with Bedrock. Bedrock has an improved project structure compared to regular WordPress installations., _(*4)

The plugin is intended as an aid for developers - there is no settings GUI., _(*5)

Instead, a configuration file which returns a PHP array is used to register custom post types and taxonomies. This means you can easily define custom post types and taxonomies for your project by simply amending an array., _(*6)

Config Files

Sample config files are provided in the /sample-config directory., _(*7)

By default, the plugin looks for config files in the config directory. You could amend this - which is outside the document root for the project. If you're using a regular WordPress installation, you may need to fork this plugin and modify the path to the config files:, _(*8)

<?php
// See: `/custom-content.php`
$path = dirname(ABSPATH, 2) . '/config/';
// Define the path to the config file for CPTs:
define('CARAWEBS_CUSTOM_CONTENT_CONFIG', $path . 'cpt-config.php');
// Define the path for the config file for custom taxonomies:
define('CARAWEBS_CUSTOM_TAX_CONFIG', $path . 'tax-config.php');

The default locations are:, _(*9)

CPT config: /path/to/example.com/config/cpt-config.php
Custom taxonomy config: /path/to/example.com/config/tax-config.php

If you're working in Bedrock and want to quickly copy across the sample config files, run this from the plugin root directory:, _(*10)

# At terminal/BASH prompt
cp sample-config/cpt-config.php ../../../../config/cpt-config.php

# More conservatively:
cp sample-config/cpt-config.php path/to/yoursite.com/config/cpt-config.php