forked from mboynes/super-cpt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
209 lines (127 loc) · 10 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
=== SuperCPT ===
Contributors: mboynes
Tags: custom-post-types, custom-post-type, cms, custom-field, custom-fields, meta, custom-taxonomy, custom-taxonomies
Requires at least: 3.0
Tested up to: 3.9
Stable tag: 0.2.1
Donate Link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=22PRU6U4U78RC
License: GPLv2 or later
Insanely easy and attractive custom post types, custom post meta, and custom taxonomies
== Description ==
= UPGRADE NOTICE =
SuperCPT now uses Font Awesome instead of Glyphicons. Some icon names will carry over, but not all. If this is a considerable inconvenience for you for a project, simply do not update it. It's not a security release, so updating isn't necessary.
= Overview =
SuperCPT is an object wrapper for Custom Post Types, Custom Taxonomies, and Custom Post Meta "for coders, by coders." Simply put, SuperCPT:
* <acronym title="Don't Repeat Yourself">DRY</acronym>s up the Custom Post Type and Custom Taxonomy process (e.g. automatically adds the name to all the labels),
* allows you to set default options for all your Custom Post Types and Taxonomies,
* significantly simplifies the process of creating, saving, and displaying Custom Post Meta,
* is sexy! Your custom fields are styled to look great and SuperCPT comes with 361 awesome icons courtesy of [Font Awesome](http://fontawesome.io/).
= Demo Video =
[vimeo http://vimeo.com/59368054]
= TextMate/Sublime Text 2 Bundle =
If you use TextMate, Sublime Text 2, or another editor which supports TextMate bundles, check out [this set of snippets](https://github.com/mboynes/super-cpt-bundle) to turbo-charge your development.
= And more... =
See the [Other Notes tab](http://wordpress.org/extend/plugins/super-cpt/other_notes/) for instructions and demo code. Find more demos and a full reference [at GitHub](https://github.com/mboynes/super-cpt/wiki).
Since you're a hard-core coder, [check this out on GitHub](https://github.com/mboynes/super-cpt) if you want to contribute!
== Installation ==
Upload the SuperCPT plugin to your blog/site and activate it. You know, like every other plugin.
== Instructions ==
Depending on when and where you're declaring your Custom Post Types and Taxonomies, you have different options for which action to hook onto. `after_setup_theme` is the safest bet, but if you're referencing this in another plugin, `plugins_loaded` is a good choice. To avoid a fatal error if something goes awry, you should check to see if the class `Super_Custom_Post_Type` exists before referencing it. Don't worry about keeping up, reference code is below.
= Custom Post Types =
To define a new Custom Post Type, instantiate the `Super_Custom_Post_Type` class with a string for the post type. For example,
$movies = new Super_Custom_Post_Type( 'movie' );
It works very much like [`register_post_type`](http://codex.wordpress.org/Function_Reference/register_post_type). The first thing you gained by using this is that the labels all got setup with either 'Movie' or 'Movies'. If our post type were 'indie-film', the labels would have "Indie Film" and "Indie Films" as appropriate. Of course, you do have the ability to set the plural word in cases such as goose/geese. You also gained the ability to define your own custom post type defaults through a filter. Lastly, you gained access to `Super_Custom_Post_Type`'s parent class, `Super_Custom_Post_Meta`, for fast, clean, intuitive custom post meta, which we'll go into shortly.
Lastly, if you've built a lot of custom post types, you're probably sick and tired of the pushpin icon. SuperCPT comes with 350 gorgeous icons courtesy of [Font Awesome](http://fontawesome.io/) that are extremely easy to implement. Here's what it looks like:
$movies->set_icon( 'film' );
= Custom Taxonomies =
To define a new Custom Taxonomy, much like with Custom Post Types, you instantiate `Super_Custom_Taxonomy` with a string for the term name. For example:
$actors = new Super_Custom_Taxonomy( 'actor' );
Again, we got free labels for doing this, using either 'Actor' or 'Actors' as appropriate, without needing to specify the 16 labels individually.
= Custom Post Meta =
Custom Post Meta is where SuperCPT shines the brightest, because this process is typically the most time-consuming. `Super_Custom_Post_Meta` is a free-standing class that can be added to any post type, even built-in post types (posts and pages). This class has a method `add_meta_box` which does the bulk of the work, and somewhat mimics the WordPress function. Here's an example:
$movies->add_meta_box( array(
'id' => 'features',
'fields' => array(
'tagline' => array( 'type' => 'text' )
)
) );
The method `add_meta_box` takes an array of parameters (unlike the core function which takes normal ordered arguments). `id` is the only required attribute, and that becomes the ID of the meta box as well as the title (this will get converted into "words" for the title, e.g. `"movie_details"` would become "Movie Details"). `fields` is an array of all the fields in the meta box. It's an associative array, where the keys in the array are the field names and the values are another associative array of attributes for the field. The keys closely reflect the HTML attributes in the resulting field, and any key not known by the plugin will in fact become an HTML attribute (e.g. passing `'data-src' => 'foo'` would become the HTML attribute `data-src="foo"` in the field). See the reference for the full gamut of options, both for the `add_meta_box` argument array and the fields array.
Long story short, using this class means you don't have to do any additional work to store data, retrieve data, style the boxes, and so on.
= Helper Functions =
SuperCPT has a couple of helper functions for displaying your post meta. `get_scpt_formatted_meta` and `the_scpt_formatted_meta`
== Demo Code ==
Here is the full demo code:
function scpt_demo() {
if ( ! class_exists( 'Super_Custom_Post_Type' ) )
return;
$demo_posts = new Super_Custom_Post_Type( 'demo-post' );
# Test Icon. Should be a square grid.
$demo_posts->set_icon( 'th-large' );
# Taxonomy test, should be like tags
$tax_tags = new Super_Custom_Taxonomy( 'tax-tag' );
# Taxonomy test, should be like categories
$tax_cats = new Super_Custom_Taxonomy( 'tax-cat', 'Tax Cat', 'Tax Cats', 'category' );
# Connect both of the above taxonomies with the post type
connect_types_and_taxes( $demo_posts, array( $tax_tags, $tax_cats ) );
# Add a meta box with every field type
$demo_posts->add_meta_box( array(
'id' => 'demo-fields',
'context' => 'normal',
'fields' => array(
'textbox-demo' => array(),
'textarea-demo' => array( 'type' => 'textarea' ),
'wysiwyg-demo' => array( 'type' => 'wysiwyg' ),
'boolean-demo' => array( 'type' => 'boolean' ),
'checkboxes-demo' => array( 'type' => 'checkbox', 'options' => array( 'one', 'two', 'three' ) ),
'radio-buttons-demo' => array( 'type' => 'radio', 'options' => array( 'one', 'two', 'three' ) ),
'select-demo' => array( 'type' => 'select', 'options' => array( 1 => 'one', 2 => 'two', 3 => 'three' ) ),
'multi-select-demo' => array( 'type' => 'select', 'options' => array( 'one', 'two', 'three' ), 'multiple' => 'multiple' ),
'date-demo' => array( 'type' => 'date' ),
'label-override-demo' => array( 'label' => 'Label Demo' )
)
) );
# Add another CPT to test one-to-one (it could just as easily be one-to-many or many-to-many)
$linked_posts = new Super_Custom_Post_Type( 'linked-post', 'Other Post', 'Other Posts' );
$linked_posts->add_meta_box( array(
'id' => 'one-to-one',
'title' => 'Testing One-to-One relationship',
'context' => 'side',
'fields' => array(
'demo-posts' => array( 'type' => 'select', 'data' => 'demo-post' ),
'side-wysiwyg' => array( 'type' => 'wysiwyg' )
)
) );
$linked_posts->set_icon( 'cogs' );
}
add_action( 'after_setup_theme', 'scpt_demo' );
== Changelog ==
= 0.2.1 =
* Improving PHP <5.3 support
= 0.2 =
* Some bug fixes
* Removed glyphicons in favor of the open-source GPL-compatible Font Awesome
* Fixed bug where CSS/JS doesn't load if plugin is in mu-plugins (props to Aaron Holbrook)
* Added magic methods for accessing and setting taxonomy and post type attributes after declaration
* Added "media" field type
* Added ability to have default values (props to github.com/Gyroscopic for the suggestion)
* Added ability to add taxonomies to the manage posts columns (props to github.com/Gyroscopic for the suggestion)
* Added ability to include the featured image in the manage posts columns (props to twitter.com/GreggFranklin for the suggestion)
= 0.1 =
Beta Release. Everything is new!
== Frequently Asked Questions ==
= What icons are available? =
You'll find a full list in Tools > SuperCPT
= I don't want my clients seeing the icon list, is there a way to hide it? =
Yes. In your plugin or theme, add: `add_filter( 'scpt_show_admin_menu', '__return_false' );`
= I'm not a programmer, can I/how do I use this plugin? =
You probably shouldn't. Check out [Custom Post Type UI](http://wordpress.org/extend/plugins/custom-post-type-ui/), [More Fields](http://wordpress.org/extend/plugins/more-fields/), and [Types - Custom Fields and Custom Post Types Management](http://wordpress.org/extend/plugins/types/).
== Upgrade Notice ==
= 0.2 =
Removed glyphicons in favor of Font Awesome. If you're using a version of WordPress less than 3.7, you should use the MP6 plugin to update your dashboard design for best results. It is still possible to use Glyphicons, but you need to purchase it to get the new font. I'll release an open-source add-on to use that font on my github account, https://github.com/mboynes
= 0.1.3 =
Adding scpt_ namespacing to global variables `$known_meta` and `$known_custom_fields` to avoid (albeit by long-odds) conflict with another plugin. If you're using these variables, please update your code to use `$scpt_known_meta` and `$scpt_known_custom_fields`.
= 0.1 =
Beta release
== To-Do ==
1. Add better support for multiple fields for one meta key
2. Add easy RSS feeds, e.g. in fields array, a parameter might be `'rss' => 'PubDate'` to prefer that field's data over the post's publication date.