Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/jjgrainger/wp-custom-post-type-class

A PHP Class for creating Wordpress Custom Post Types easily
https://github.com/jjgrainger/wp-custom-post-type-class

custom-post-types wordpress

Last synced: 3 months ago
JSON representation

A PHP Class for creating Wordpress Custom Post Types easily

Lists

README 

        
**N.B** I've released an updated version of the project to a new repository, [PostTypes](https://github.com/jjgrainger/PostTypes).



# WP Custom Post Type Class v1.4



[![Latest Stable Version](https://poser.pugx.org/jjgrainger/wp-custom-post-type-class/v/stable)](https://packagist.org/packages/jjgrainger/wp-custom-post-type-class) [![Total Downloads](https://poser.pugx.org/jjgrainger/wp-custom-post-type-class/downloads)](https://packagist.org/packages/jjgrainger/wp-custom-post-type-class) [![License](https://poser.pugx.org/jjgrainger/wp-custom-post-type-class/license)](https://packagist.org/packages/jjgrainger/wp-custom-post-type-class)



> A single class to help you build more advanced custom post types quickly.



## Installation



#### Install with Composer



Add the package to your projects `composer.json` file. Visit [getcomposer.org](http://getcomposer.org/) more information.



```json

{

    "require": {

        "jjgrainger/wp-custom-post-type-class": "dev-master"

    }

}

```



#### Install Manually



Download and include the class file into your themes `functions.php` like so:



```php

include_once('CPT.php');

```



and your ready to roll!



## Creating a new Custom Post type



To create the post type simply create a new object



```php

$books = new CPT('book');

```



The first parameter is the post type name and is required. ideally the post type name is all lowercase and words separated with an underscore `_`.



to be specific about other post types names you can pass an associative array:



`post_type_name` - the name of post type (singular, lowercase, underscores)



`singular` - the singular label of the post type (Book, Person)



`plural` - the plural of the post type (Books, People)



`slug` - the permalink slug for the post type (plural, lowercase, hyphens)



you pass these names through the first parameter as an array like so:



```php

$people = new CPT(array(

	'post_type_name' => 'person',

	'singular' => 'Person',

	'plural' => 'People',

	'slug' => 'people'

));

```



The optional second parameter is the arguments for the post_type.

see [WordPress codex](http://codex.wordpress.org/Function_Reference/register_post_type#Parameters) for available options.



The Class uses the WordPress defaults where possible.



To override the default options simply pass an array of options as the second parameter. Not all options have to be passed just the ones you want to add/override like so:



```php

$books = new CPT('book', array(

	'supports' => array('title', 'editor', 'thumbnail', 'comments')

));

```



See the [WordPress codex](http://codex.wordpress.org/Function_Reference/register_post_type#Parameters) for all available options.



## Existing Post Types



To work with exisiting post types, simply pass the post type name into the class constructor



```php

$blog = new CPT('post');

```



## Adding Taxonomies



You can add taxonomies easily using the `register_taxonomy()` method like so:



```php

$books->register_taxonomy('genres');

```



this method accepts two arguments, names and options. The taxonomy name is required and can be string (the taxonomy name), or an array of names following same format as post types:



```php

$books->register_taxonomy(array(

	'taxonomy_name' => 'genre',

	'singular' => 'Genre',

	'plural' => 'Genres',

	'slug' => 'genre'

));

```



Again options can be passed optionally as an array. see the [WordPress codex](http://codex.wordpress.org/Function_Reference/register_taxonomy#Parameters) for all possible options.



### Existing Taxonomies



You can add exisiting taxonomies to the post type by passing the taxonomy name through the `register_taxonomy` method. You will only need to specify the options for the custom taxonomy **once**, when its first registered.



## Admin Edit Screen



### Filters



When you register a taxonomy it is *automagically* added to the admin edit screen as a filter and a column.



You can define what filters you want to appear by using the `filters()` method:



```php

$books->filters(array('genre'));

```



By passing an array of taxonomy names you can choose the filters that appear and the order they appear in. If you pass an empty array, no drop down filters will appear on the admin edit screen.



### Columns



The Class has a number of methods to help you modify the admin columns.

Taxonomies registered with this class are automagically added to the admin edit screen as columns.



You can add your own custom columns to include what ever value you want, for example with our books post type we will add custom fields for a price and rating.



This class doesn't have any methods for adding custom fields as [Advanced Custom Fields (ACF)](http://advancedcustomfields.com) is way more awesome than anything this class could do!



You can define what columns you want to appear on the admin edit screen with the `columns()` method by passing an array like so:



```php

$books->columns(array(

	'cb' => '',

	'title' => __('Title'),

	'genre' => __('Genres'),

	'price' => __('Price'),

	'rating' => __('Rating'),

	'date' => __('Date')

));

```



The key defines the name of the column, the value is the label that appears for that column. The following column names are *automagically* populated by the class:



- any taxonomy registered through the object

- `cb` the checkbox for bulk editing

- `title` the post title with the edit link

- `author` the post author

- `post_id` the posts id

- `icon`  the posts thumbnail



#### Populating Columns



You will need to create a function to populate a column that isn't *automagically* populated.



You do so with the `populate_column()` method like so:



```php

$books->populate_column('column_name', function($column, $post) {



	// your code goes here…



});

```



so we can populate our price column like so:



```php

$books->populate_column('price', function($column, $post) {



	echo "£" . get_field('price'); // ACF get_field() function



});

```



The method will pass two variables into the function:



* `$column` - The column name (not the label)

* `$post` - The current post object



These are passed to help you populate the column appropriately.



#### Sorting Columns



If it makes sense that column should be sortable by ascending/descending you can define custom sortable columns like so:



```php

$books->sortable(array(

	'column_name' => array('meta_key', true)

));

```



The `true/false` is used to define whether the meta value is a string or integer,

reason being is that if numbers are ordered as a string, numbers such as:



	1, 3, 5, 11, 14, 21, 33



Would be ordered as:



	1, 11, 14, 21, 3, 33, 5



By adding the option true value the values will be sorted as integers, if false or undefined, the class will sort columns as string.



so for our books example you will use:



```php

$books->sortable(array(

	'price' => array('price', true),

	'rating' => array('rating', true)

));

```



### Menu Icons



#### Dashicons



With WordPress 3.8 comes [dashicons](https://developer.wordpress.org/resource/dashicons/) an icon font you can use with your custom post types. To use simply pass the icon name through the `menu_icon()` method like so:



```php

$books->menu_icon("dashicons-book-alt");

```



For a full list of icons and the class names to use visit [https://developer.wordpress.org/resource/dashicons/](https://developer.wordpress.org/resource/dashicons/)



### Translation



The class is setup for translation, but if you need to set your own textdomain to work with your theme or plugin use the `set_textdomain()` method:



```php

$books->set_textdomain('your-textdomain');

```



### Flush Rewrite Rules



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](https://codex.wordpress.org/Function_Reference/flush_rewrite_rules) for more.



```php

$books->flush();

```



## Notes



* The class has no methods for making custom fields for post types, use [Advanced Custom Fields](http://advancedcustomfields.com)

* The books example used in the README.md can be found in the [books-post-type.php](examples/books-post-type.php)

* Licensed under the [MIT License](https://github.com/jjgrainger/wp-custom-post-type-class/blob/master/LICENSE)

* Maintained under the [Semantic Versioning Guide](http://semver.org)



## Author



**Joe Grainger**

* [http://jjgrainger.co.uk](http://jjgrainger.co.uk)

* [http://twitter.com/jjgrainger](http://twitter.com/jjgrainger)