forked from CMB2/CMB2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
example-functions.php
427 lines (416 loc) · 14.7 KB
/
example-functions.php
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
<?php
/**
* Include and setup custom metaboxes and fields. (make sure you copy this file to outside the CMB directory)
*
* @category YourThemeOrPlugin
* @package Metaboxes
* @license http://www.opensource.org/licenses/gpl-license.php GPL v2.0 (or later)
* @link https://github.com/webdevstudios/Custom-Metaboxes-and-Fields-for-WordPress
*/
/**
* Get the bootstrap! If using the plugin from wordpress.org, REMOVE THIS!
*/
if ( file_exists( __DIR__ . '/cmb2/init.php' ) ) {
require_once __DIR__ . '/cmb2/init.php';
} elseif ( file_exists( __DIR__ . '/CMB2/init.php' ) ) {
require_once __DIR__ . '/CMB2/init.php';
}
/**
* Conditionally displays a field when used as a callback in the 'show_on_cb' field parameter
*
* @param CMB2_Field object $field Field object
*
* @return bool True if metabox should show
*/
function cmb2_hide_if_no_cats( $field ) {
// Don't show this field if not in the cats category
if ( ! has_tag( 'cats', $field->object_id ) ) {
return false;
}
return true;
}
add_filter( 'cmb2_meta_boxes', 'cmb2_sample_metaboxes' );
/**
* Define the metabox and field configurations.
*
* @param array $meta_boxes
* @return array
*/
function cmb2_sample_metaboxes( array $meta_boxes ) {
// Start with an underscore to hide fields from custom fields list
$prefix = '_cmb2_';
/**
* Sample metabox to demonstrate each field type included
*/
$meta_boxes['test_metabox'] = array(
'id' => 'test_metabox',
'title' => __( 'Test Metabox', 'cmb2' ),
'object_types' => array( 'page', ), // Post type
'context' => 'normal',
'priority' => 'high',
'show_names' => true, // Show field names on the left
// 'cmb_styles' => false, // false to disable the CMB stylesheet
'fields' => array(
array(
'name' => __( 'Test Text', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_text',
'type' => 'text',
'show_on_cb' => 'cmb2_hide_if_no_cats', // function should return a bool value
// 'sanitization_cb' => 'my_custom_sanitization', // custom sanitization callback parameter
// 'escape_cb' => 'my_custom_escaping', // custom escaping callback parameter
// 'on_front' => false, // Optionally designate a field to wp-admin only
// 'repeatable' => true,
),
array(
'name' => __( 'Test Text Small', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_textsmall',
'type' => 'text_small',
// 'repeatable' => true,
),
array(
'name' => __( 'Test Text Medium', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_textmedium',
'type' => 'text_medium',
// 'repeatable' => true,
),
array(
'name' => __( 'Website URL', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'url',
'type' => 'text_url',
// 'protocols' => array('http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet'), // Array of allowed protocols
// 'repeatable' => true,
),
array(
'name' => __( 'Test Text Email', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'email',
'type' => 'text_email',
// 'repeatable' => true,
),
array(
'name' => __( 'Test Time', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_time',
'type' => 'text_time',
),
array(
'name' => __( 'Time zone', 'cmb2' ),
'desc' => __( 'Time zone', 'cmb2' ),
'id' => $prefix . 'timezone',
'type' => 'select_timezone',
),
array(
'name' => __( 'Test Date Picker', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_textdate',
'type' => 'text_date',
),
array(
'name' => __( 'Test Date Picker (UNIX timestamp)', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_textdate_timestamp',
'type' => 'text_date_timestamp',
// 'timezone_meta_key' => $prefix . 'timezone', // Optionally make this field honor the timezone selected in the select_timezone specified above
),
array(
'name' => __( 'Test Date/Time Picker Combo (UNIX timestamp)', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_datetime_timestamp',
'type' => 'text_datetime_timestamp',
),
// This text_datetime_timestamp_timezone field type
// is only compatible with PHP versions 5.3 or above.
// Feel free to uncomment and use if your server meets the requirement
// array(
// 'name' => __( 'Test Date/Time Picker/Time zone Combo (serialized DateTime object)', 'cmb2' ),
// 'desc' => __( 'field description (optional)', 'cmb2' ),
// 'id' => $prefix . 'test_datetime_timestamp_timezone',
// 'type' => 'text_datetime_timestamp_timezone',
// ),
array(
'name' => __( 'Test Money', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_textmoney',
'type' => 'text_money',
// 'before_field' => '£', // override '$' symbol if needed
// 'repeatable' => true,
),
array(
'name' => __( 'Test Color Picker', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_colorpicker',
'type' => 'colorpicker',
'default' => '#ffffff'
),
array(
'name' => __( 'Test Text Area', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_textarea',
'type' => 'textarea',
),
array(
'name' => __( 'Test Text Area Small', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_textareasmall',
'type' => 'textarea_small',
),
array(
'name' => __( 'Test Text Area for Code', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_textarea_code',
'type' => 'textarea_code',
),
array(
'name' => __( 'Test Title Weeeee', 'cmb2' ),
'desc' => __( 'This is a title description', 'cmb2' ),
'id' => $prefix . 'test_title',
'type' => 'title',
),
array(
'name' => __( 'Test Select', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_select',
'type' => 'select',
'options' => array(
'standard' => __( 'Option One', 'cmb2' ),
'custom' => __( 'Option Two', 'cmb2' ),
'none' => __( 'Option Three', 'cmb2' ),
),
),
array(
'name' => __( 'Test Radio inline', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_radio_inline',
'type' => 'radio_inline',
'options' => array(
'standard' => __( 'Option One', 'cmb2' ),
'custom' => __( 'Option Two', 'cmb2' ),
'none' => __( 'Option Three', 'cmb2' ),
),
),
array(
'name' => __( 'Test Radio', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_radio',
'type' => 'radio',
'options' => array(
'option1' => __( 'Option One', 'cmb2' ),
'option2' => __( 'Option Two', 'cmb2' ),
'option3' => __( 'Option Three', 'cmb2' ),
),
),
array(
'name' => __( 'Test Taxonomy Radio', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'text_taxonomy_radio',
'type' => 'taxonomy_radio',
'taxonomy' => 'category', // Taxonomy Slug
// 'inline' => true, // Toggles display to inline
),
array(
'name' => __( 'Test Taxonomy Select', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'text_taxonomy_select',
'type' => 'taxonomy_select',
'taxonomy' => 'category', // Taxonomy Slug
),
array(
'name' => __( 'Test Taxonomy Multi Checkbox', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_multitaxonomy',
'type' => 'taxonomy_multicheck',
'taxonomy' => 'post_tag', // Taxonomy Slug
// 'inline' => true, // Toggles display to inline
),
array(
'name' => __( 'Test Checkbox', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_checkbox',
'type' => 'checkbox',
),
array(
'name' => __( 'Test Multi Checkbox', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_multicheckbox',
'type' => 'multicheck',
'options' => array(
'check1' => __( 'Check One', 'cmb2' ),
'check2' => __( 'Check Two', 'cmb2' ),
'check3' => __( 'Check Three', 'cmb2' ),
),
// 'inline' => true, // Toggles display to inline
),
array(
'name' => __( 'Test wysiwyg', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'test_wysiwyg',
'type' => 'wysiwyg',
'options' => array( 'textarea_rows' => 5, ),
),
array(
'name' => __( 'Test Image', 'cmb2' ),
'desc' => __( 'Upload an image or enter a URL.', 'cmb2' ),
'id' => $prefix . 'test_image',
'type' => 'file',
),
array(
'name' => __( 'Multiple Files', 'cmb2' ),
'desc' => __( 'Upload or add multiple images/attachments.', 'cmb2' ),
'id' => $prefix . 'test_file_list',
'type' => 'file_list',
'preview_size' => array( 100, 100 ), // Default: array( 50, 50 )
),
array(
'name' => __( 'oEmbed', 'cmb2' ),
'desc' => __( 'Enter a youtube, twitter, or instagram URL. Supports services listed at <a href="http://codex.wordpress.org/Embeds">http://codex.wordpress.org/Embeds</a>.', 'cmb2' ),
'id' => $prefix . 'test_embed',
'type' => 'oembed',
),
),
);
/**
* Metabox to be displayed on a single page ID
*/
$meta_boxes['about_page_metabox'] = array(
'id' => 'about_page_metabox',
'title' => __( 'About Page Metabox', 'cmb2' ),
'object_types' => array( 'page', ), // Post type
'context' => 'normal',
'priority' => 'high',
'show_names' => true, // Show field names on the left
'show_on' => array( 'id' => array( 2, ) ), // Specific post IDs to display this metabox
'fields' => array(
array(
'name' => __( 'Test Text', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . '_about_test_text',
'type' => 'text',
),
)
);
/**
* Repeatable Field Groups
*/
$meta_boxes['field_group'] = array(
'id' => 'field_group',
'title' => __( 'Repeating Field Group', 'cmb2' ),
'object_types' => array( 'page', ),
'fields' => array(
array(
'id' => $prefix . 'repeat_group',
'type' => 'group',
'description' => __( 'Generates reusable form entries', 'cmb2' ),
'options' => array(
'group_title' => __( 'Entry {#}', 'cmb2' ), // {#} gets replaced by row number
'add_button' => __( 'Add Another Entry', 'cmb2' ),
'remove_button' => __( 'Remove Entry', 'cmb2' ),
'sortable' => true, // beta
),
// Fields array works the same, except id's only need to be unique for this group. Prefix is not needed.
'fields' => array(
array(
'name' => 'Entry Title',
'id' => 'title',
'type' => 'text',
// 'repeatable' => true, // Repeatable fields are supported w/in repeatable groups (for most types)
),
array(
'name' => 'Description',
'description' => 'Write a short description for this entry',
'id' => 'description',
'type' => 'textarea_small',
),
array(
'name' => 'Entry Image',
'id' => 'image',
'type' => 'file',
),
array(
'name' => 'Image Caption',
'id' => 'image_caption',
'type' => 'text',
),
),
),
),
);
/**
* Metabox for the user profile screen
*/
$meta_boxes['user_edit'] = array(
'id' => 'user_edit',
'title' => __( 'User Profile Metabox', 'cmb2' ),
'object_types' => array( 'user' ), // Tells CMB to use user_meta vs post_meta
'show_names' => true,
'new_user_section' => 'add-new-user', // where form will show on new user page. 'add-existing-user' is only other valid option.
'fields' => array(
array(
'name' => __( 'Extra Info', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'exta_info',
'type' => 'title',
'on_front' => false,
),
array(
'name' => __( 'Avatar', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'avatar',
'type' => 'file',
),
array(
'name' => __( 'Facebook URL', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'facebookurl',
'type' => 'text_url',
),
array(
'name' => __( 'Twitter URL', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'twitterurl',
'type' => 'text_url',
),
array(
'name' => __( 'Google+ URL', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'googleplusurl',
'type' => 'text_url',
),
array(
'name' => __( 'Linkedin URL', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'linkedinurl',
'type' => 'text_url',
),
array(
'name' => __( 'User Field', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'user_text_field',
'type' => 'text',
),
)
);
/**
* Metabox for an options page. Will not be added automatically, but needs to be called with
* the `cmb2_metabox_form` helper function. See wiki for more info.
*/
$meta_boxes['options_page'] = array(
'id' => 'options_page',
'title' => __( 'Theme Options Metabox', 'cmb2' ),
'show_on' => array( 'options-page' => array( $prefix . 'theme_options', ), ),
'fields' => array(
array(
'name' => __( 'Site Background Color', 'cmb2' ),
'desc' => __( 'field description (optional)', 'cmb2' ),
'id' => $prefix . 'bg_color',
'type' => 'colorpicker',
'default' => '#ffffff'
),
)
);
// Add other metaboxes as needed
return $meta_boxes;
}