README

CPT Module

This module helps register a custom post type simpler.

Installation

composer require vietartisans/cpter

Arguments

Name	Type	Required	Description	Default
name	string	yes	Post type. (max. 20 characters, cannot contain capital letters or spaces)	book, music,...
singular	string	no	name for one object of this post type. Default is Post/Page	Book, Music,...
plural	string	no	name for multiple object of this post type. Default is Posts/Pages	Posts, Pages,...
args	array	no	An array of arguments	---

Args

Name	Type	Required	Description	Default
labels	array	no	An array of labels for this post type. By default, post labels are used for non-hierarchical post types and page labels for hierarchical ones	if empty, `name` is set to value of `label`, and `singular_name` is set to value of `name`
public	boolean	no	Controls how the type is visible to authors `(show_in_nav_menus, show_ui)` and readers `(exclude_from_search, publicly_queryable)`	false
publicly_queryable	boolean	no	Whether queries can be performed on the front end as part of parse_request()	value of `public` argument
show_ui	boolean	no	Whether to generate a default UI for managing this post type in the admin	value of `public` argument
show_in_menu	boolean/string	no	Where to show the post type in the admin menu. `show_ui` must be `true`	value of `show_ui` argument
has_archive	boolean/string	no	Enables post type archives. Will use $post_type as archive slug by default	false
supports	array/boolean	no	An alias for calling add_post_type_support() directly. As of 3.5, boolean false can be passed as value instead of an array to prevent default (title and editor) behavior	title and editor

Labels

Name	Description	Default
name	general name for the post type, usually plural. The same and overridden by $post_type_object->label	Posts/Pages
singular_name	name for one object of this post type	Post/Page
add_new	the add new text	The default is Add New
add_new_item	the add new text	Default is Add New Post/Add New Page
edit_item	-	Default is Edit Post/Edit Page
new_item	-	Default is New Post/New Page
view_item	-	Default is View Post/View Page
view_items	Label for viewing post type archives	Default is View Posts / View Pages
search_items	-	Default is Search Posts/Search Pages
not_found	-	Default is No posts found/No pages found
not_found_in_trash	-	Default is No posts found in Trash/No pages found in Trash
parent_item_colon	This string isn't used on non-hierarchical types	In hierarchical ones the default is Parent Page:
all_items	String for the submenu	Default is All Posts/All Pages
archives	String for use with archives in nav menus	Default is Post Archives/Page Archives
attributes	Label for the attributes meta box	Default is Post Attributes / Page Attributes
insert_into_item	String for the media frame button	Default is Insert into post/Insert into page
uploaded_to_this_item	String for the media frame filter	Default is Uploaded to this post/Uploaded to this page
featured_image	-	Default is Featured Image
set_featured_image	-	Default is Set featured image
use_featured_image	-	Default is Use as featured image
menu_name	-	Default is the same as name
filter_items_list	String for the table views hidden heading	-
items_list_navigation	String for the table pagination hidden heading	-
items_list	String for the table hidden heading	-
name_admin_bar	String for use in New in Admin menu bar	Default is the same as singular_name

Usage

1. Use alias function

registerCpter('book', 'Book', 'Books');

2. Create a CPT child class

Register a custom post type with default arguments

$book = new Vietfreshair\CPT('book', 'Book', 'Books');

Register a custom post type with specific arguments

$song = new Vietfreshair\CPT(
    'song', 
    'Song', 
    'Songs', 
    ['menu_icon' => 'dashicons-format-audio']
);

Register a custom post type with meta fields

NOTE: We are using CMB2 to create meta fields for custom post type. See here to find out how to use CMB2. You can see a list of available field types here.

$book->registerMetafields(
	[
		[
	        'id'            => 'test_metabox',
	        'title'         => __( 'Test Metabox', 'cmb2' ),
	        'context'       => 'normal',
	        'priority'      => 'high',
	        'show_names'    => true, // Show field names on the left
	        // 'cmb_styles' => false, // false to disable the CMB stylesheet
	        // 'closed'     => true, // Keep the metabox closed by default
	        'fields'        => [
	        	[
			        'name' => __( 'Website URL', 'cmb2' ),
			        'desc' => __( 'field description (optional)', 'cmb2' ),
			        'id'   => 'url',
			        'type' => 'text_url',
			    ],
			    [
			        'name' => __( 'Test Text Email', 'cmb2' ),
			        'desc' => __( 'field description (optional)', 'cmb2' ),
			        'id'   => 'email',
			        'type' => 'text_email',
			        // 'repeatable' => true,
			    ]
	        ]
		],
		[
	        'id'            => 'test_metabox_2',
	        'title'         => __( 'Test Metabox', 'cmb2' ),
	        'context'       => 'normal',
	        'priority'      => 'high',
	        'show_names'    => true, // Show field names on the left
	        // 'cmb_styles' => false, // false to disable the CMB stylesheet
	        // 'closed'     => true, // Keep the metabox closed by default
	        'fields'        => [
	        	[
			        'name' => __( 'Website URL', 'cmb2' ),
			        'desc' => __( 'field description (optional)', 'cmb2' ),
			        'id'   => 'url',
			        'type' => 'text_url',
			    ],
			    [
			        'name' => __( 'Test Text Email', 'cmb2' ),
			        'desc' => __( 'field description (optional)', 'cmb2' ),
			        'id'   => 'email',
			        'type' => 'text_email',
			        // 'repeatable' => true,
			    ]
	        ]
		]
	]
);