soberwp/models

WordPress plugin to create custom post types and taxonomies using JSON, YAML or PHP files.

Models

Models is a WordPress plugin allowing you to create custom post types and taxonomies using JSON, YAML or PHP files., _(*1)

You can now set post types and taxonomies using Intervention 2.x.x., _(*2)

Installation

Composer:

Recommended methods:, _(*3)

Roots Bedrock, _(*4)

$ composer require soberwp/models:1.1.0

Models is a mu-plugin so it doesn't have to be activated., _(*5)

Roots Sage, _(*6)

$ composer require soberwp/models:1.1.0-p

Manual:

• Download the zip file
• Unzip to your sites plugin folder
• Activate via WordPress

Requirements:

• PHP >= 5.6.x

Setup

By default, create folder models/ within the active theme directory., _(*7)

If you are a Roots Sage the default folder is app/models/, _(*8)

Alternatively, you can define a custom path using the filter below within your themes functions.php file:, _(*9)

add_filter('sober/models/path', function () {
    return get_stylesheet_directory() . '/your-custom-folder';
});

That's it, now go ahead and add model-name.json files, in the folder or subfolders to begin creating your models. Use Unravel to automatically move the config files outside of your theme path for better separation of concerns., _(*10)

Usage

The data structure follows a similar data structure to WordPress taxonomies and post types arrays, so if an config option is missing from the examples below, follow the developer's reference and place it within "config": {}, _(*11)

If values are not specified, defaults are the same as WordPress defaults., _(*12)

Additionally, if the Extended CPTs library is available, Models will use it when registering your post types and taxonomies instead allowing extended functionality within your Models., _(*13)

Extracted examples presented below are in JSON format., _(*14)

Post Types

Create a custom post type., _(*15)

Required:

• post-type-required.json
• post-type-required.php
• post-type-required.yaml

{
  "type": "post-type",
  "name": "book"
}

Basic:

• post-type-basic.json
• post-type-basic.php
• post-type-basic.yaml

{
  "type": "cpt",
  "name": "book",
  "supports": [
    "title", "editor", "thumbnail"
  ],
  "labels": {
    "has_one": "Book",
    "has_many": "Books",
    "text_domain": "sage"
  }
}

In the above example, "labels": {} are redundant because "Book" and "Books" would have been generated from "name"., _(*16)

Multiple:

• post-type-multiple.json
• post-type-multiple.php
• post-type-multiple.yaml

[
  {
    "type": "cpt",
    "name": "book",
    "supports": [
      "title", "editor", "thumbnail"
    ]
  },
  {
    "type": "cpt",
    "name": "album",
    "supports": [
      "title", "editor", "comments"
    ]
  }
]

All Fields:

• post-type-all.json
• post-type-all.php
• post-type-all.yaml

Post Type Tips:

• "active": false stops the post type from being created. Default is set to true.
• "type": "post-type" also accepts a shorthand "type": "cpt";

Taxonomies

Create a custom taxonomy., _(*17)

Required:

• taxonomy-required.json
• taxonomy-required.php
• taxonomy-required.yaml

{
  "type": "taxonomy",
  "name": "genre"
}

Basic:

• taxonomy-basic.json
• taxonomy-basic.php
• taxonomy-basic.yaml

{
  "type": "tax",
  "name": "genre",
  "links": [
    "post", "book"
  ],
  "labels": {
    "has_one": "Book Genre",
    "has_many": "Book Genres",
    "text_domain": "sage"
  }
}

"links": (string|array) assigns the taxonomy to post types. Defaults to "links": "post", _(*18)

Multiple:

• taxonomy-multiple.json
• taxonomy-multiple.php
• taxonomy-multiple.yaml

[
  {
    "type": "category",
    "name": "genre",
    "links": "book"
  },
  {
    "type": "tag",
    "name": "author",
    "links": "book"
  }
]

"type": "category" and "type": "tag" shorthands are explained below under Tips., _(*19)

All Fields:

• taxonomy-all.json
• taxonomy-all.php
• taxonomy-all.yaml

Taxonomy Tips:

• "active": false stops the taxonomy from being created. Default is set to true.
• "type": "taxonomy" also accepts shorthands;
  • "type": "tax"
  • "type": "category" or "type": "cat" creates a category taxonomy.
  • "type": "tag" creates a tag taxonomy.

Support

• Follow @withjacoby on Twitter
• Buy me a beer or pay my rent, paypal.me/darrenjacoby

Updates

Composer:

• Change the composer.json version to ^1.0.4**
• Check CHANGELOG.md for any breaking changes before updating.

$ composer update

WordPress:

Includes support for github-updater to keep track on updates through the WordPress backend. * Download github-updater * Clone github-updater to your sites plugins/ folder * Activate via WordPress, _(*20)