Simple WordPress custom post types.
Run the following in your terminal to install PostTypes with Composer.
$ composer require jjgrainger/posttypes
As PostTypes uses PSR-4 autoloading you will need to use Composers autoloader. Below is a basic example of getting started with the class, though your setup maybe different depending on how you are using composer.
require __DIR__ . '/vendor/autoload.php';
use PostTypes\PostType;
$books = new PostType('book');See Composers basic usage guide for details on working Composer and autoloading.
A new post type can be created by simply passing the post types name to the class constructor.
$books = new PostType('book');The post type labels and slugs are automatically generated from the post type name, however, if you need to define these manually pass an array of names to the post types constructor.
$names = [
'name' => 'book',
'singular' => 'Book',
'plural' => 'Books',
'slug' => 'books'
];
$books = new PostType($names);It can accept the following names:
nameis the post type name (required, singular, lowercase, underscores)singularis the singular label for the post type (Book, Person)pluralis the plural label for the post type (Books, People)slugis the post type slug used in the permalinks (plural, lowercase, hyphens)
The only required name is the post types name.
You can define the options for the post type by passing an array as the second argument in the class constructor.
$options = [
'has_archive' => false
];
$books = new PostType('book', $options);All available options are on the WordPress Codex
You can define the labels for the post type by passing an array as the third argument in the class constructor.
$labels = [
'featured_image' => __( 'Book Cover Image' ),
];
$books = new PostType('book', $options, $labels);All available labels are on the WordPress Codex
To work with exisiting post types simple pass the post type name into the object. Be careful using global variables (i.e $post) which can lead to unwanted results.
$blog = new PostType('post');Adding taxonomies to a post type is easily achieved by using the taxonomy() method.
To create a new taxonomy simply pass the taxonomy name to the taxonomy() method. Labels and the taxonomy slug are generated from the taxonomy name.
$books->taxonomy('genre');You can define names by passing an array as the first argument. Only the name is required.
nameis the post type namesingularis the singular label for the post typepluralis the plural label for the post typeslugis the post type slug used in the permalinks
$names = [
'name' => 'genre',
'singular' => 'Genre',
'plural' => 'Genres',
'slug' => 'genres'
];
$books->taxonomy($names);You can further customise taxonomies by passing an array of options as the second argument to the method.
$options = [
'hierarchical' => false,
];
$books->taxonomy('genre', $options);All available options are on the WordPress Codex
You can add existing taxonomies by passing the taxonomy name to the taxonomy() method. This works with custom taxonomies too. You only need to pass the options/names for the taxonomy once, afterwards you only need to pass the taxonomy name.
$books->taxonomy('post_tag');Set the taxonomy filters on the admin edit screen by passing an array to the filters() method
$books->filters(['genres', 'category']);The order of the filters are set by the order of the items in the array. An empty array will remove all dropdown filters.
You can add columns to the admin edit screen by passing an array of slugs and labels to the add() method.
// add multiple columns and set their labels
$books->columns()->add([
'rating' => __('Rating'),
'price' => __('Price')
]);You can hide columns by passing the column slug to the hide() method. You can hide multiple columns by passing an array of column slugs.
$books->columns()->hide('author');
$books->columns()->hide(['author', 'date']);You can force set all the columns to display on the admin page with the set() method by passing an array of the column slugs and labels.
$books->columns()->set([
'cb' => '<input type="checkbox" />',
'title' => __("Title"),
'genre' => __("Genres"),
'rating' => __("Rating"),
'date' => __("Date")
]);After hiding and adding columns you may want to rearrange the column order. To do this use the order() method. You only have to pass through an array of the columns you want to reposition, not all of them. Their positions are based on a zero based index.
$books->columns()->order([
'rating' => 2,
'genre' => 4
]);Columns that are automatically populated with correct slug
post_id- the post idtitle- the posts title with edit linksauthor- the posts authordate- the posts dates{taxonomy_name}- a list of the taxonomy terms attached to the postthumbnail- the post featured imagemeta_{meta_key}- the post meta for that key
$books->columns()->populate('rating', function($column, $post_id) {
echo get_post_meta($post_id, 'rating', true) . '/10';
});You can choose which custom columns are sortable with the sortable() method. This method accepts an array of column slugs and an array of sorting options.
The first option is the meta_key to sort the colums by.
The second option is whether to order the items numerically (true) or alphabetically (false) by default.
// will make both the price and rating columns sortable and ordered numerically
$books->columns()->sortable([
'price' => ['price', true],
'rating' => ['rating', true]
]);With WordPress 3.8 comes Dashicons an icon font you can use with your custom post types.
$books->icon('dashicons-book-alt');You can programmatically recreate the sites rewrite rules with the flush() method.
This is an expensive operation and should be used with caution, see codex for more.
$books->flush();The class is setup for translation, but if you need to set your own textdomain to work with your theme or plugin use the translation() method:
$books->translation('your-textdomain');- The class has no methods for making custom fields for post types, use Advanced Custom Fields
- The books example used in the README.md can be found in the examples/books.php
- Licensed under the MIT License
- Maintained under the Semantic Versioning Guide
Joe Grainger