Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like CMB2 often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use CMB2, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
17 | class CMB2 extends CMB2_Base { |
||
|
|||
18 | |||
19 | /** |
||
20 | * The object properties name. |
||
21 | * @var string |
||
22 | * @since 2.2.3 |
||
23 | */ |
||
24 | protected $properties_name = 'meta_box'; |
||
25 | |||
26 | /** |
||
27 | * Metabox Config array |
||
28 | * @var array |
||
29 | * @since 0.9.0 |
||
30 | */ |
||
31 | protected $meta_box = array(); |
||
32 | |||
33 | /** |
||
34 | * Type of object registered for metabox. (e.g., post, user, or comment) |
||
35 | * @var string |
||
36 | * @since 1.0.0 |
||
37 | */ |
||
38 | protected $mb_object_type = null; |
||
39 | |||
40 | /** |
||
41 | * List of fields that are changed/updated on save |
||
42 | * @var array |
||
43 | * @since 1.1.0 |
||
44 | */ |
||
45 | protected $updated = array(); |
||
46 | |||
47 | /** |
||
48 | * Metabox Defaults |
||
49 | * @var array |
||
50 | * @since 1.0.1 |
||
51 | */ |
||
52 | protected $mb_defaults = array( |
||
53 | 'id' => '', |
||
54 | 'title' => '', |
||
55 | 'object_types' => array(), // Post type |
||
56 | 'context' => 'normal', |
||
57 | 'priority' => 'high', |
||
58 | 'show_names' => true, // Show field names on the left |
||
59 | 'show_on_cb' => null, // Callback to determine if metabox should display. |
||
60 | 'show_on' => array(), // Post IDs or page templates to display this metabox. overrides 'show_on_cb' |
||
61 | 'cmb_styles' => true, // Include CMB2 stylesheet |
||
62 | 'enqueue_js' => true, // Include CMB2 JS |
||
63 | 'fields' => array(), |
||
64 | 'hookup' => true, |
||
65 | 'save_fields' => true, // Will not save during hookup if false |
||
66 | 'closed' => false, // Default to metabox being closed? |
||
67 | 'taxonomies' => array(), |
||
68 | 'new_user_section' => 'add-new-user', // or 'add-existing-user' |
||
69 | 'new_term_section' => true, |
||
70 | 'show_in_rest' => false, |
||
71 | ); |
||
72 | |||
73 | /** |
||
74 | * Metabox field objects |
||
75 | * @var array |
||
76 | * @since 2.0.3 |
||
77 | */ |
||
78 | protected $fields = array(); |
||
79 | |||
80 | /** |
||
81 | * An array of hidden fields to output at the end of the form |
||
82 | * @var array |
||
83 | * @since 2.0.0 |
||
84 | */ |
||
85 | protected $hidden_fields = array(); |
||
86 | |||
87 | /** |
||
88 | * Array of key => value data for saving. Likely $_POST data. |
||
89 | * @var string |
||
90 | * @since 2.0.0 |
||
91 | */ |
||
92 | protected $generated_nonce = ''; |
||
93 | |||
94 | /** |
||
95 | * Whether there are fields to be shown in columns. Set in CMB2::add_field(). |
||
96 | * @var bool |
||
97 | * @since 2.2.2 |
||
98 | */ |
||
99 | protected $has_columns = false; |
||
100 | |||
101 | /** |
||
102 | * If taxonomy field is requesting to remove_default, we store the taxonomy here. |
||
103 | * @var array |
||
104 | * @since 2.2.3 |
||
105 | */ |
||
106 | protected $tax_metaboxes_to_remove = array(); |
||
107 | |||
108 | /** |
||
109 | * Get started |
||
110 | * @since 0.4.0 |
||
111 | * @param array $config Metabox config array |
||
112 | * @param integer $object_id Optional object id |
||
113 | */ |
||
114 | 46 | public function __construct( $config, $object_id = 0 ) { |
|
115 | |||
116 | 46 | if ( empty( $config['id'] ) ) { |
|
117 | 1 | wp_die( esc_html__( 'Metabox configuration is required to have an ID parameter.', 'cmb2' ) ); |
|
118 | } |
||
119 | |||
120 | 46 | $this->meta_box = wp_parse_args( $config, $this->mb_defaults ); |
|
121 | 46 | $this->meta_box['fields'] = array(); |
|
122 | |||
123 | 46 | $this->object_id( $object_id ); |
|
124 | 46 | $this->mb_object_type(); |
|
125 | 46 | $this->cmb_id = $config['id']; |
|
126 | |||
127 | 46 | if ( ! empty( $config['fields'] ) && is_array( $config['fields'] ) ) { |
|
128 | 43 | $this->add_fields( $config['fields'] ); |
|
129 | 43 | } |
|
130 | |||
131 | 46 | CMB2_Boxes::add( $this ); |
|
132 | |||
133 | /** |
||
134 | * Hook during initiation of CMB2 object |
||
135 | * |
||
136 | * The dynamic portion of the hook name, $this->cmb_id, is this meta_box id. |
||
137 | * |
||
138 | * @param array $cmb This CMB2 object |
||
139 | */ |
||
140 | 46 | do_action( "cmb2_init_{$this->cmb_id}", $this ); |
|
141 | 46 | } |
|
142 | |||
143 | /** |
||
144 | * Loops through and displays fields |
||
145 | * @since 1.0.0 |
||
146 | * @param int $object_id Object ID |
||
147 | * @param string $object_type Type of object being saved. (e.g., post, user, or comment) |
||
148 | */ |
||
149 | 1 | public function show_form( $object_id = 0, $object_type = '' ) { |
|
150 | 1 | $this->render_form_open( $object_id, $object_type ); |
|
151 | |||
152 | 1 | foreach ( $this->prop( 'fields' ) as $field_args ) { |
|
153 | 1 | $this->render_field( $field_args ); |
|
154 | 1 | } |
|
155 | |||
156 | 1 | $this->render_form_close( $object_id, $object_type ); |
|
157 | 1 | } |
|
158 | |||
159 | /** |
||
160 | * Outputs the opening form markup and runs corresponding hooks: |
||
161 | * 'cmb2_before_form' and "cmb2_before_{$object_type}_form_{$this->cmb_id}" |
||
162 | * @since 2.2.0 |
||
163 | * @param integer $object_id Object ID |
||
164 | * @param string $object_type Object type |
||
165 | * @return void |
||
166 | */ |
||
167 | 1 | public function render_form_open( $object_id = 0, $object_type = '' ) { |
|
168 | 1 | $object_type = $this->object_type( $object_type ); |
|
169 | 1 | $object_id = $this->object_id( $object_id ); |
|
170 | |||
171 | 1 | echo "\n<!-- Begin CMB2 Fields -->\n"; |
|
172 | |||
173 | 1 | $this->nonce_field(); |
|
174 | |||
175 | /** |
||
176 | * Hook before form table begins |
||
177 | * |
||
178 | * @param array $cmb_id The current box ID |
||
179 | * @param int $object_id The ID of the current object |
||
180 | * @param string $object_type The type of object you are working with. |
||
181 | * Usually `post` (this applies to all post-types). |
||
182 | * Could also be `comment`, `user` or `options-page`. |
||
183 | * @param array $cmb This CMB2 object |
||
184 | */ |
||
185 | 1 | do_action( 'cmb2_before_form', $this->cmb_id, $object_id, $object_type, $this ); |
|
186 | |||
187 | /** |
||
188 | * Hook before form table begins |
||
189 | * |
||
190 | * The first dynamic portion of the hook name, $object_type, is the type of object |
||
191 | * you are working with. Usually `post` (this applies to all post-types). |
||
192 | * Could also be `comment`, `user` or `options-page`. |
||
193 | * |
||
194 | * The second dynamic portion of the hook name, $this->cmb_id, is the meta_box id. |
||
195 | * |
||
196 | * @param array $cmb_id The current box ID |
||
197 | * @param int $object_id The ID of the current object |
||
198 | * @param array $cmb This CMB2 object |
||
199 | */ |
||
200 | 1 | do_action( "cmb2_before_{$object_type}_form_{$this->cmb_id}", $object_id, $this ); |
|
201 | |||
202 | 1 | echo '<div class="', $this->box_classes(), '"><div id="cmb2-metabox-', sanitize_html_class( $this->cmb_id ), '" class="cmb2-metabox cmb-field-list">'; |
|
203 | |||
204 | 1 | } |
|
205 | |||
206 | /** |
||
207 | * Defines the classes for the CMB2 form/wrap. |
||
208 | * |
||
209 | * @since 2.0.0 |
||
210 | * @return string Space concatenated list of classes |
||
211 | */ |
||
212 | 1 | public function box_classes() { |
|
213 | |||
214 | 1 | $classes = array( 'cmb2-wrap', 'form-table' ); |
|
215 | |||
216 | // Use the callback to fetch classes. |
||
217 | 1 | View Code Duplication | if ( $added_classes = $this->get_param_callback_result( 'classes_cb' ) ) { |
218 | 1 | $added_classes = is_array( $added_classes ) ? $added_classes : array( $added_classes ); |
|
219 | 1 | $classes = array_merge( $classes, $added_classes ); |
|
220 | 1 | } |
|
221 | |||
222 | 1 | View Code Duplication | if ( $added_classes = $this->prop( 'classes' ) ) { |
223 | 1 | $added_classes = is_array( $added_classes ) ? $added_classes : array( $added_classes ); |
|
224 | 1 | $classes = array_merge( $classes, $added_classes ); |
|
225 | 1 | } |
|
226 | |||
227 | /** |
||
228 | * Globally filter box wrap classes |
||
229 | * |
||
230 | * @since 2.2.2 |
||
231 | * |
||
232 | * @param string $classes Array of classes for the cmb2-wrap. |
||
233 | * @param CMB2 $cmb This CMB2 object. |
||
234 | */ |
||
235 | 1 | $classes = apply_filters( 'cmb2_wrap_classes', $classes, $this ); |
|
236 | |||
237 | // Clean up. |
||
238 | 1 | $classes = array_map( 'strip_tags', array_filter( $classes ) ); |
|
239 | |||
240 | // Make a string. |
||
241 | 1 | return implode( ' ', $classes ); |
|
242 | } |
||
243 | |||
244 | /** |
||
245 | * Outputs the closing form markup and runs corresponding hooks: |
||
246 | * 'cmb2_after_form' and "cmb2_after_{$object_type}_form_{$this->cmb_id}" |
||
247 | * @since 2.2.0 |
||
248 | * @param integer $object_id Object ID |
||
249 | * @param string $object_type Object type |
||
250 | * @return void |
||
251 | */ |
||
252 | 1 | public function render_form_close( $object_id = 0, $object_type = '' ) { |
|
289 | |||
290 | /** |
||
291 | * Renders a field based on the field type |
||
292 | * @since 2.2.0 |
||
293 | * @param array $field_args A field configuration array. |
||
294 | * @return mixed CMB2_Field object if successful. |
||
295 | */ |
||
296 | 1 | public function render_field( $field_args ) { |
|
297 | 1 | $field_args['context'] = $this->prop( 'context' ); |
|
298 | |||
299 | 1 | if ( 'group' == $field_args['type'] ) { |
|
300 | |||
301 | if ( ! isset( $field_args['show_names'] ) ) { |
||
302 | $field_args['show_names'] = $this->prop( 'show_names' ); |
||
303 | } |
||
304 | $field = $this->render_group( $field_args ); |
||
305 | |||
306 | 1 | } elseif ( 'hidden' == $field_args['type'] && $this->get_field( $field_args )->should_show() ) { |
|
307 | // Save rendering for after the metabox |
||
308 | $field = $this->add_hidden_field( $field_args ); |
||
309 | |||
310 | } else { |
||
311 | |||
312 | 1 | $field_args['show_names'] = $this->prop( 'show_names' ); |
|
313 | |||
314 | // Render default fields |
||
315 | 1 | $field = $this->get_field( $field_args )->render_field(); |
|
316 | } |
||
317 | |||
318 | 1 | return $field; |
|
319 | } |
||
320 | |||
321 | /** |
||
322 | * Render a repeatable group. |
||
323 | * @param array $args Array of field arguments for a group field parent. |
||
324 | * @return CMB2_Field|null Group field object. |
||
325 | */ |
||
326 | 2 | public function render_group( $args ) { |
|
327 | |||
328 | 2 | if ( ! isset( $args['id'], $args['fields'] ) || ! is_array( $args['fields'] ) ) { |
|
329 | return; |
||
330 | } |
||
331 | |||
332 | 2 | $field_group = $this->get_field( $args ); |
|
333 | |||
334 | // If field is requesting to be conditionally shown |
||
335 | 2 | if ( ! $field_group || ! $field_group->should_show() ) { |
|
336 | return; |
||
337 | } |
||
338 | |||
339 | 2 | $desc = $field_group->args( 'description' ); |
|
340 | 2 | $label = $field_group->args( 'name' ); |
|
341 | 2 | $group_val = (array) $field_group->value(); |
|
342 | 2 | $remove_disabled = count( $group_val ) <= 1 ? 'disabled="disabled" ' : ''; |
|
343 | 2 | $field_group->index = 0; |
|
344 | |||
345 | 2 | $field_group->peform_param_callback( 'before_group' ); |
|
346 | |||
347 | 2 | echo '<div class="cmb-row cmb-repeat-group-wrap ', $field_group->row_classes(), '" data-fieldtype="group"><div class="cmb-td"><div data-groupid="', $field_group->id(), '" id="', $field_group->id(), '_repeat" ', $this->group_wrap_attributes( $field_group ), '>'; |
|
348 | |||
349 | 2 | if ( $desc || $label ) { |
|
350 | 2 | $class = $desc ? ' cmb-group-description' : ''; |
|
351 | 2 | echo '<div class="cmb-row', $class, '"><div class="cmb-th">'; |
|
352 | 2 | if ( $label ) { |
|
353 | 2 | echo '<h2 class="cmb-group-name">', $label, '</h2>'; |
|
354 | 2 | } |
|
355 | 2 | if ( $desc ) { |
|
356 | 1 | echo '<p class="cmb2-metabox-description">', $desc, '</p>'; |
|
357 | 1 | } |
|
358 | 2 | echo '</div></div>'; |
|
359 | 2 | } |
|
360 | |||
361 | 2 | if ( ! empty( $group_val ) ) { |
|
362 | foreach ( $group_val as $group_key => $field_id ) { |
||
363 | $this->render_group_row( $field_group, $remove_disabled ); |
||
364 | $field_group->index++; |
||
365 | } |
||
366 | } else { |
||
367 | 2 | $this->render_group_row( $field_group, $remove_disabled ); |
|
368 | } |
||
369 | |||
370 | 2 | if ( $field_group->args( 'repeatable' ) ) { |
|
371 | 1 | echo '<div class="cmb-row"><div class="cmb-td"><p class="cmb-add-row"><button type="button" data-selector="', $field_group->id(), '_repeat" data-grouptitle="', $field_group->options( 'group_title' ), '" class="cmb-add-group-row button">', $field_group->options( 'add_button' ), '</button></p></div></div>'; |
|
372 | 1 | } |
|
373 | |||
374 | 2 | echo '</div></div></div>'; |
|
375 | |||
376 | 2 | $field_group->peform_param_callback( 'after_group' ); |
|
377 | |||
378 | 2 | return $field_group; |
|
379 | } |
||
380 | |||
381 | /** |
||
382 | * Get the group wrap attributes, which are passed through a filter. |
||
383 | * @since 2.2.3 |
||
384 | * @param CMB2_Field $field_group The group CMB2_Field object. |
||
385 | * @return string The attributes string. |
||
386 | */ |
||
387 | 2 | public function group_wrap_attributes( $field_group ) { |
|
388 | 2 | $classes = 'cmb-nested cmb-field-list cmb-repeatable-group'; |
|
389 | 2 | $classes .= $field_group->options( 'sortable' ) ? ' sortable' : ' non-sortable'; |
|
390 | 2 | $classes .= $field_group->args( 'repeatable' ) ? ' repeatable' : ' non-repeatable'; |
|
391 | |||
392 | $group_wrap_attributes = array( |
||
393 | 2 | 'class' => $classes, |
|
394 | 2 | 'style' => 'width:100%;', |
|
395 | 2 | ); |
|
396 | |||
397 | /** |
||
398 | * Allow for adding additional HTML attributes to a group wrapper. |
||
399 | * |
||
400 | * The attributes will be an array of key => value pairs for each attribute. |
||
401 | * |
||
402 | * @since 2.2.2 |
||
403 | * |
||
404 | * @param string $group_wrap_attributes Current attributes array. |
||
405 | * |
||
406 | * @param CMB2_Field $field_group The group CMB2_Field object. |
||
407 | */ |
||
408 | 2 | $group_wrap_attributes = apply_filters( 'cmb2_group_wrap_attributes', $group_wrap_attributes, $field_group ); |
|
409 | |||
410 | 2 | return CMB2_Utils::concat_attrs( $group_wrap_attributes ); |
|
411 | } |
||
412 | |||
413 | /** |
||
414 | * Render a repeatable group row |
||
415 | * @since 1.0.2 |
||
416 | * @param CMB2_Field $field_group CMB2_Field group field object |
||
417 | * @param string $remove_disabled Attribute string to disable the remove button |
||
418 | */ |
||
419 | 2 | public function render_group_row( $field_group, $remove_disabled ) { |
|
420 | |||
421 | 2 | $field_group->peform_param_callback( 'before_group_row' ); |
|
422 | 2 | $closed_class = $field_group->options( 'closed' ) ? ' closed' : ''; |
|
423 | |||
424 | echo ' |
||
425 | 2 | <div class="postbox cmb-row cmb-repeatable-grouping', $closed_class, '" data-iterator="', $field_group->index, '">'; |
|
426 | |||
427 | 2 | if ( $field_group->args( 'repeatable' ) ) { |
|
428 | 1 | echo '<button type="button" ', $remove_disabled, 'data-selector="', $field_group->id(), '_repeat" class="dashicons-before dashicons-no-alt cmb-remove-group-row" title="', esc_attr( $field_group->options( 'remove_button' ) ), '"></button>'; |
|
429 | 1 | } |
|
430 | |||
431 | echo ' |
||
432 | 2 | <div class="cmbhandle" title="' , esc_attr__( 'Click to toggle', 'cmb2' ), '"><br></div> |
|
433 | 2 | <h3 class="cmb-group-title cmbhandle-title"><span>', $field_group->replace_hash( $field_group->options( 'group_title' ) ), '</span></h3> |
|
434 | |||
435 | <div class="inside cmb-td cmb-nested cmb-field-list">'; |
||
436 | // Loop and render repeatable group fields |
||
437 | 2 | foreach ( array_values( $field_group->args( 'fields' ) ) as $field_args ) { |
|
438 | 2 | if ( 'hidden' == $field_args['type'] ) { |
|
439 | |||
440 | // Save rendering for after the metabox |
||
441 | $this->add_hidden_field( $field_args, $field_group ); |
||
442 | |||
443 | } else { |
||
444 | |||
445 | 2 | $field_args['show_names'] = $field_group->args( 'show_names' ); |
|
446 | 2 | $field_args['context'] = $field_group->args( 'context' ); |
|
447 | |||
448 | 2 | $field = $this->get_field( $field_args, $field_group )->render_field(); |
|
449 | } |
||
450 | 2 | } |
|
451 | 2 | if ( $field_group->args( 'repeatable' ) ) { |
|
452 | echo ' |
||
453 | <div class="cmb-row cmb-remove-field-row"> |
||
454 | <div class="cmb-remove-row"> |
||
455 | 1 | <button type="button" ', $remove_disabled, 'data-selector="', $field_group->id(), '_repeat" class="button cmb-remove-group-row alignright">', $field_group->options( 'remove_button' ), '</button> |
|
456 | </div> |
||
457 | </div> |
||
458 | '; |
||
459 | 1 | } |
|
460 | echo ' |
||
461 | </div> |
||
462 | </div> |
||
463 | 2 | '; |
|
464 | |||
465 | 2 | $field_group->peform_param_callback( 'after_group_row' ); |
|
466 | 2 | } |
|
467 | |||
468 | /** |
||
469 | * Add a hidden field to the list of hidden fields to be rendered later |
||
470 | * @since 2.0.0 |
||
471 | * @param array $field_args Array of field arguments to be passed to CMB2_Field |
||
472 | * @param CMB2_Field|null $field_group CMB2_Field group field object |
||
473 | */ |
||
474 | public function add_hidden_field( $field_args, $field_group = null ) { |
||
475 | if ( isset( $field_args['field_args'] ) ) { |
||
476 | // For back-compatibility. |
||
477 | $field = new CMB2_Field( $field_args ); |
||
478 | } else { |
||
479 | $field = $this->get_new_field( $field_args, $field_group ); |
||
480 | } |
||
481 | |||
482 | $type = new CMB2_Types( $field ); |
||
483 | |||
484 | if ( $field_group ) { |
||
485 | $type->iterator = $field_group->index; |
||
486 | } |
||
487 | |||
488 | $this->hidden_fields[] = $type; |
||
489 | |||
490 | return $field; |
||
491 | } |
||
492 | |||
493 | /** |
||
494 | * Loop through and output hidden fields |
||
495 | * @since 2.0.0 |
||
496 | */ |
||
497 | 1 | public function render_hidden_fields() { |
|
498 | 1 | if ( ! empty( $this->hidden_fields ) ) { |
|
499 | foreach ( $this->hidden_fields as $hidden ) { |
||
500 | $hidden->render(); |
||
501 | } |
||
502 | } |
||
503 | 1 | } |
|
504 | |||
505 | /** |
||
506 | * Returns array of sanitized field values (without saving them) |
||
507 | * @since 2.0.3 |
||
508 | * @param array $data_to_sanitize Array of field_id => value data for sanitizing (likely $_POST data). |
||
509 | */ |
||
510 | 2 | public function get_sanitized_values( array $data_to_sanitize ) { |
|
511 | 2 | $this->data_to_save = $data_to_sanitize; |
|
512 | 2 | $stored_id = $this->object_id(); |
|
513 | |||
514 | // We do this So CMB will sanitize our data for us, but not save it |
||
515 | 2 | $this->object_id( '_' ); |
|
516 | |||
517 | // Ensure temp. data store is empty |
||
518 | 2 | cmb2_options( 0 )->set(); |
|
519 | |||
520 | // Process/save fields |
||
521 | 2 | $this->process_fields(); |
|
522 | |||
523 | // Get data from temp. data store |
||
524 | 2 | $sanitized_values = cmb2_options( 0 )->get_options(); |
|
525 | |||
526 | // Empty out temp. data store again |
||
527 | 2 | cmb2_options( 0 )->set(); |
|
528 | |||
529 | // Reset the object id |
||
530 | 2 | $this->object_id( $stored_id ); |
|
531 | |||
532 | 2 | return $sanitized_values; |
|
533 | } |
||
534 | |||
535 | /** |
||
536 | * Loops through and saves field data |
||
537 | * @since 1.0.0 |
||
538 | * @param int $object_id Object ID |
||
539 | * @param string $object_type Type of object being saved. (e.g., post, user, or comment) |
||
540 | * @param array $data_to_save Array of key => value data for saving. Likely $_POST data. |
||
541 | */ |
||
542 | 1 | public function save_fields( $object_id = 0, $object_type = '', $data_to_save = array() ) { |
|
543 | |||
544 | // Fall-back to $_POST data |
||
545 | 1 | $this->data_to_save = ! empty( $data_to_save ) ? $data_to_save : $_POST; |
|
546 | 1 | $object_id = $this->object_id( $object_id ); |
|
547 | 1 | $object_type = $this->object_type( $object_type ); |
|
548 | |||
549 | 1 | $this->process_fields(); |
|
550 | |||
551 | // If options page, save the updated options |
||
552 | 1 | if ( 'options-page' == $object_type ) { |
|
553 | 1 | cmb2_options( $object_id )->set(); |
|
554 | 1 | } |
|
555 | |||
556 | 1 | $this->after_save(); |
|
557 | 1 | } |
|
558 | |||
559 | /** |
||
560 | * Process and save form fields |
||
561 | * @since 2.0.0 |
||
562 | */ |
||
563 | 3 | public function process_fields() { |
|
564 | |||
565 | 3 | $this->pre_process(); |
|
566 | |||
567 | // Remove the show_on properties so saving works |
||
568 | 3 | $this->prop( 'show_on', array() ); |
|
569 | |||
570 | // save field ids of those that are updated |
||
571 | 3 | $this->updated = array(); |
|
572 | |||
573 | 3 | foreach ( $this->prop( 'fields' ) as $field_args ) { |
|
574 | 3 | $this->process_field( $field_args ); |
|
575 | 3 | } |
|
576 | 3 | } |
|
577 | |||
578 | /** |
||
579 | * Process and save a field |
||
580 | * @since 2.0.0 |
||
581 | * @param array $field_args Array of field arguments |
||
582 | */ |
||
583 | 3 | public function process_field( $field_args ) { |
|
584 | |||
585 | 3 | switch ( $field_args['type'] ) { |
|
586 | |||
587 | 3 | case 'group': |
|
588 | 1 | if ( $this->save_group( $field_args ) ) { |
|
589 | 1 | $this->updated[] = $field_args['id']; |
|
590 | 1 | } |
|
591 | |||
592 | 1 | break; |
|
593 | |||
594 | 2 | case 'title': |
|
595 | // Don't process title fields |
||
596 | break; |
||
597 | |||
598 | 2 | default: |
|
599 | |||
600 | 2 | $field = $this->get_new_field( $field_args ); |
|
601 | |||
602 | 2 | if ( $field->save_field_from_data( $this->data_to_save ) ) { |
|
603 | 2 | $this->updated[] = $field->id(); |
|
604 | 2 | } |
|
605 | |||
606 | 2 | break; |
|
607 | 3 | } |
|
608 | |||
609 | 3 | } |
|
610 | |||
611 | 3 | public function pre_process() { |
|
612 | /** |
||
613 | * Fires before fields have been processed/saved. |
||
614 | * |
||
615 | * The dynamic portion of the hook name, $this->cmb_id, is the meta_box id. |
||
616 | * |
||
617 | * The dynamic portion of the hook name, $object_type, refers to the metabox/form's object type |
||
618 | * Usually `post` (this applies to all post-types). |
||
619 | * Could also be `comment`, `user` or `options-page`. |
||
620 | * |
||
621 | * @param array $cmb This CMB2 object |
||
622 | * @param int $object_id The ID of the current object |
||
623 | */ |
||
624 | 3 | do_action( "cmb2_{$this->object_type()}_process_fields_{$this->cmb_id}", $this, $this->object_id() ); |
|
625 | 3 | } |
|
626 | |||
627 | 1 | public function after_save() { |
|
628 | 1 | $object_type = $this->object_type(); |
|
629 | 1 | $object_id = $this->object_id(); |
|
630 | |||
631 | /** |
||
632 | * Fires after all fields have been saved. |
||
633 | * |
||
634 | * The dynamic portion of the hook name, $object_type, refers to the metabox/form's object type |
||
635 | * Usually `post` (this applies to all post-types). |
||
636 | * Could also be `comment`, `user` or `options-page`. |
||
637 | * |
||
638 | * @param int $object_id The ID of the current object |
||
639 | * @param array $cmb_id The current box ID |
||
640 | * @param string $updated Array of field ids that were updated. |
||
641 | * Will only include field ids that had values change. |
||
642 | * @param array $cmb This CMB2 object |
||
643 | */ |
||
644 | 1 | do_action( "cmb2_save_{$object_type}_fields", $object_id, $this->cmb_id, $this->updated, $this ); |
|
645 | |||
646 | /** |
||
647 | * Fires after all fields have been saved. |
||
648 | * |
||
649 | * The dynamic portion of the hook name, $this->cmb_id, is the meta_box id. |
||
650 | * |
||
651 | * The dynamic portion of the hook name, $object_type, refers to the metabox/form's object type |
||
652 | * Usually `post` (this applies to all post-types). |
||
653 | * Could also be `comment`, `user` or `options-page`. |
||
654 | * |
||
655 | * @param int $object_id The ID of the current object |
||
656 | * @param string $updated Array of field ids that were updated. |
||
657 | * Will only include field ids that had values change. |
||
658 | * @param array $cmb This CMB2 object |
||
659 | */ |
||
660 | 1 | do_action( "cmb2_save_{$object_type}_fields_{$this->cmb_id}", $object_id, $this->updated, $this ); |
|
661 | 1 | } |
|
662 | |||
663 | /** |
||
664 | * Save a repeatable group |
||
665 | * @since 1.x.x |
||
666 | * @param array $args Field arguments array |
||
667 | * @return mixed Return of CMB2_Field::update_data() |
||
668 | */ |
||
669 | 1 | public function save_group( $args ) { |
|
670 | 1 | if ( ! isset( $args['id'], $args['fields'] ) || ! is_array( $args['fields'] ) ) { |
|
671 | return; |
||
672 | } |
||
673 | |||
674 | 1 | return $this->save_group_field( $this->get_new_field( $args ) ); |
|
675 | } |
||
676 | |||
677 | /** |
||
678 | * Save a repeatable group |
||
679 | * @since 1.x.x |
||
680 | * @param CMB2_Field $field_group CMB2_Field group field object |
||
681 | * @return mixed Return of CMB2_Field::update_data() |
||
682 | */ |
||
683 | 1 | public function save_group_field( $field_group ) { |
|
684 | 1 | $base_id = $field_group->id(); |
|
685 | |||
686 | 1 | if ( ! isset( $this->data_to_save[ $base_id ] ) ) { |
|
687 | return; |
||
688 | } |
||
689 | |||
690 | 1 | $old = $field_group->get_data(); |
|
691 | // Check if group field has sanitization_cb |
||
692 | 1 | $group_vals = $field_group->sanitization_cb( $this->data_to_save[ $base_id ] ); |
|
693 | 1 | $saved = array(); |
|
694 | |||
695 | 1 | $field_group->index = 0; |
|
696 | 1 | $field_group->data_to_save = $this->data_to_save; |
|
697 | |||
698 | 1 | foreach ( array_values( $field_group->fields() ) as $field_args ) { |
|
699 | 1 | if ( 'title' === $field_args['type'] ) { |
|
700 | // Don't process title fields |
||
701 | continue; |
||
702 | } |
||
703 | |||
704 | 1 | $field = $this->get_new_field( $field_args, $field_group ); |
|
705 | 1 | $sub_id = $field->id( true ); |
|
706 | |||
707 | 1 | foreach ( (array) $group_vals as $field_group->index => $post_vals ) { |
|
708 | |||
709 | // Get value |
||
710 | 1 | $new_val = isset( $group_vals[ $field_group->index ][ $sub_id ] ) |
|
711 | 1 | ? $group_vals[ $field_group->index ][ $sub_id ] |
|
712 | 1 | : false; |
|
713 | |||
714 | // Sanitize |
||
715 | 1 | $new_val = $field->sanitization_cb( $new_val ); |
|
716 | |||
717 | 1 | if ( is_array( $new_val ) && $field->args( 'has_supporting_data' ) ) { |
|
718 | 1 | if ( $field->args( 'repeatable' ) ) { |
|
719 | 1 | $_new_val = array(); |
|
720 | 1 | foreach ( $new_val as $group_index => $grouped_data ) { |
|
721 | // Add the supporting data to the $saved array stack |
||
722 | 1 | $saved[ $field_group->index ][ $grouped_data['supporting_field_id'] ][] = $grouped_data['supporting_field_value']; |
|
723 | // Reset var to the actual value |
||
724 | 1 | $_new_val[ $group_index ] = $grouped_data['value']; |
|
725 | 1 | } |
|
726 | 1 | $new_val = $_new_val; |
|
727 | 1 | } else { |
|
728 | // Add the supporting data to the $saved array stack |
||
729 | 1 | $saved[ $field_group->index ][ $new_val['supporting_field_id'] ] = $new_val['supporting_field_value']; |
|
730 | // Reset var to the actual value |
||
731 | 1 | $new_val = $new_val['value']; |
|
732 | } |
||
733 | 1 | } |
|
734 | |||
735 | // Get old value |
||
736 | 1 | $old_val = is_array( $old ) && isset( $old[ $field_group->index ][ $sub_id ] ) |
|
737 | 1 | ? $old[ $field_group->index ][ $sub_id ] |
|
738 | 1 | : false; |
|
739 | |||
740 | 1 | $is_updated = ( ! CMB2_Utils::isempty( $new_val ) && $new_val !== $old_val ); |
|
741 | 1 | $is_removed = ( CMB2_Utils::isempty( $new_val ) && ! CMB2_Utils::isempty( $old_val ) ); |
|
742 | |||
743 | // Compare values and add to `$updated` array |
||
744 | 1 | if ( $is_updated || $is_removed ) { |
|
745 | 1 | $this->updated[] = $base_id . '::' . $field_group->index . '::' . $sub_id; |
|
746 | 1 | } |
|
747 | |||
748 | // Add to `$saved` array |
||
749 | 1 | $saved[ $field_group->index ][ $sub_id ] = $new_val; |
|
750 | |||
751 | 1 | } |
|
752 | |||
753 | 1 | $saved[ $field_group->index ] = CMB2_Utils::filter_empty( $saved[ $field_group->index ] ); |
|
754 | 1 | } |
|
755 | |||
756 | 1 | $saved = CMB2_Utils::filter_empty( $saved ); |
|
757 | |||
758 | 1 | return $field_group->update_data( $saved, true ); |
|
759 | } |
||
760 | |||
761 | /** |
||
762 | * Get object id from global space if no id is provided |
||
763 | * @since 1.0.0 |
||
764 | * @param integer $object_id Object ID |
||
765 | * @return integer $object_id Object ID |
||
766 | */ |
||
767 | 50 | public function object_id( $object_id = 0 ) { |
|
768 | 50 | global $pagenow; |
|
769 | |||
770 | 50 | if ( $object_id ) { |
|
771 | 18 | $this->object_id = $object_id; |
|
772 | 18 | return $this->object_id; |
|
773 | } |
||
774 | |||
775 | 47 | if ( $this->object_id ) { |
|
776 | 13 | return $this->object_id; |
|
777 | } |
||
778 | |||
779 | // Try to get our object ID from the global space |
||
780 | 44 | switch ( $this->object_type() ) { |
|
781 | 44 | case 'user': |
|
782 | $object_id = isset( $_REQUEST['user_id'] ) ? $_REQUEST['user_id'] : $object_id; |
||
783 | $object_id = ! $object_id && 'user-new.php' != $pagenow && isset( $GLOBALS['user_ID'] ) ? $GLOBALS['user_ID'] : $object_id; |
||
784 | break; |
||
785 | |||
786 | 44 | case 'comment': |
|
787 | $object_id = isset( $_REQUEST['c'] ) ? $_REQUEST['c'] : $object_id; |
||
788 | $object_id = ! $object_id && isset( $GLOBALS['comments']->comment_ID ) ? $GLOBALS['comments']->comment_ID : $object_id; |
||
789 | break; |
||
790 | |||
791 | 44 | case 'term': |
|
792 | $object_id = isset( $_REQUEST['tag_ID'] ) ? $_REQUEST['tag_ID'] : $object_id; |
||
793 | break; |
||
794 | |||
795 | 44 | default: |
|
796 | 44 | $object_id = isset( $GLOBALS['post']->ID ) ? $GLOBALS['post']->ID : $object_id; |
|
797 | 44 | $object_id = isset( $_REQUEST['post'] ) ? $_REQUEST['post'] : $object_id; |
|
798 | 44 | break; |
|
799 | 44 | } |
|
800 | |||
801 | // reset to id or 0 |
||
802 | 44 | $this->object_id = $object_id ? $object_id : 0; |
|
803 | |||
804 | 44 | return $this->object_id; |
|
805 | } |
||
806 | |||
807 | /** |
||
808 | * Sets the $object_type based on metabox settings |
||
809 | * @since 1.0.0 |
||
810 | * @return string Object type |
||
811 | */ |
||
812 | 46 | public function mb_object_type() { |
|
813 | 46 | if ( null !== $this->mb_object_type ) { |
|
814 | 12 | return $this->mb_object_type; |
|
815 | } |
||
816 | |||
817 | 46 | if ( $this->is_options_page_mb() ) { |
|
818 | 38 | $this->mb_object_type = 'options-page'; |
|
819 | 38 | return $this->mb_object_type; |
|
820 | } |
||
821 | |||
822 | 45 | $registered_types = $this->box_types(); |
|
823 | |||
824 | 45 | $type = ''; |
|
825 | |||
826 | // if it's an array of one, extract it |
||
827 | 45 | if ( 1 === count( $registered_types ) ) { |
|
828 | 45 | $last = end( $registered_types ); |
|
829 | 45 | if ( is_string( $last ) ) { |
|
830 | 45 | $type = $last; |
|
831 | 45 | } |
|
832 | 45 | } elseif ( ( $curr_type = $this->current_object_type() ) && in_array( $curr_type, $registered_types, true ) ) { |
|
833 | $type = $curr_type; |
||
834 | } |
||
835 | |||
836 | // Get our object type |
||
837 | switch ( $type ) { |
||
838 | |||
839 | 45 | case 'user': |
|
840 | 45 | case 'comment': |
|
841 | 45 | case 'term': |
|
842 | 1 | $this->mb_object_type = $type; |
|
843 | 1 | break; |
|
844 | |||
845 | 45 | default: |
|
846 | 45 | $this->mb_object_type = 'post'; |
|
847 | 45 | break; |
|
848 | 45 | } |
|
849 | |||
850 | 45 | return $this->mb_object_type; |
|
851 | } |
||
852 | |||
853 | /** |
||
854 | * Gets the box 'object_types' array based on box settings. |
||
855 | * @since 2.2.3 |
||
856 | * @return array Object types |
||
857 | */ |
||
858 | 45 | public function box_types() { |
|
859 | 45 | return CMB2_Utils::ensure_array( $this->prop( 'object_types' ), array( 'post' ) ); |
|
860 | } |
||
861 | |||
862 | /** |
||
863 | * Determines if metabox is for an options page |
||
864 | * @since 1.0.1 |
||
865 | * @return boolean True/False |
||
866 | */ |
||
867 | 46 | public function is_options_page_mb() { |
|
870 | |||
871 | /** |
||
872 | * Returns the object type |
||
873 | * @since 1.0.0 |
||
874 | * @return string Object type |
||
875 | */ |
||
876 | 50 | public function object_type( $object_type = '' ) { |
|
877 | 50 | if ( $object_type ) { |
|
878 | 18 | $this->object_type = $object_type; |
|
879 | 18 | return $this->object_type; |
|
880 | } |
||
881 | |||
882 | 47 | if ( $this->object_type ) { |
|
883 | 47 | return $this->object_type; |
|
884 | } |
||
885 | |||
886 | $this->object_type = $this->current_object_type(); |
||
887 | |||
888 | return $this->object_type; |
||
889 | } |
||
890 | |||
891 | /** |
||
892 | * Get the object type for the current page, based on the $pagenow global. |
||
893 | * @since 2.2.2 |
||
894 | * @return string Page object type name. |
||
895 | */ |
||
896 | View Code Duplication | public function current_object_type() { |
|
897 | global $pagenow; |
||
898 | $type = 'post'; |
||
899 | |||
900 | if ( in_array( $pagenow, array( 'user-edit.php', 'profile.php', 'user-new.php' ), true ) ) { |
||
901 | $type = 'user'; |
||
902 | } |
||
903 | |||
904 | if ( in_array( $pagenow, array( 'edit-comments.php', 'comment.php' ), true ) ) { |
||
905 | $type = 'comment'; |
||
906 | } |
||
907 | |||
908 | if ( in_array( $pagenow, array( 'edit-tags.php', 'term.php' ), true ) ) { |
||
909 | $type = 'term'; |
||
910 | } |
||
911 | |||
912 | return $type; |
||
913 | } |
||
914 | |||
915 | /** |
||
916 | * Set metabox property. |
||
917 | * @since 2.2.2 |
||
918 | * @param string $property Metabox config property to retrieve |
||
919 | * @param mixed $value Value to set if no value found |
||
920 | * @return mixed Metabox config property value or false |
||
921 | */ |
||
922 | 1 | public function set_prop( $property, $value ) { |
|
923 | 1 | $this->meta_box[ $property ] = $value; |
|
924 | |||
925 | 1 | return $this->prop( $property ); |
|
926 | } |
||
927 | |||
928 | /** |
||
929 | * Get metabox property and optionally set a fallback |
||
930 | * @since 2.0.0 |
||
931 | * @param string $property Metabox config property to retrieve |
||
932 | * @param mixed $fallback Fallback value to set if no value found |
||
933 | * @return mixed Metabox config property value or false |
||
934 | */ |
||
935 | 46 | public function prop( $property, $fallback = null ) { |
|
936 | 46 | if ( array_key_exists( $property, $this->meta_box ) ) { |
|
937 | 46 | return $this->meta_box[ $property ]; |
|
938 | 1 | } elseif ( $fallback ) { |
|
939 | 1 | return $this->meta_box[ $property ] = $fallback; |
|
940 | } |
||
941 | 1 | } |
|
942 | |||
943 | /** |
||
944 | * Get a field object |
||
945 | * @since 2.0.3 |
||
946 | * @param string|array|CMB2_Field $field Metabox field id or field config array or CMB2_Field object |
||
947 | * @param CMB2_Field|null $field_group (optional) CMB2_Field object (group parent) |
||
948 | * @return CMB2_Field|false CMB2_Field object (or false) |
||
949 | */ |
||
950 | 15 | public function get_field( $field, $field_group = null ) { |
|
951 | 15 | if ( $field instanceof CMB2_Field ) { |
|
952 | return $field; |
||
953 | } |
||
954 | |||
955 | 15 | $field_id = is_string( $field ) ? $field : $field['id']; |
|
956 | |||
957 | 15 | $parent_field_id = ! empty( $field_group ) ? $field_group->id() : ''; |
|
958 | 15 | $ids = $this->get_field_ids( $field_id, $parent_field_id, true ); |
|
959 | |||
960 | 15 | if ( ! $ids ) { |
|
961 | return false; |
||
962 | } |
||
963 | |||
964 | 15 | list( $field_id, $sub_field_id ) = $ids; |
|
965 | |||
966 | 15 | $index = implode( '', $ids ) . ( $field_group ? $field_group->index : '' ); |
|
967 | 15 | if ( array_key_exists( $index, $this->fields ) ) { |
|
968 | 4 | return $this->fields[ $index ]; |
|
969 | } |
||
970 | |||
971 | 13 | $this->fields[ $index ] = new CMB2_Field( $this->get_field_args( $field_id, $field, $sub_field_id, $field_group ) ); |
|
972 | |||
973 | 13 | return $this->fields[ $index ]; |
|
974 | } |
||
975 | |||
976 | /** |
||
977 | * Handles determining which type of arguments to pass to CMB2_Field |
||
978 | * @since 2.0.7 |
||
979 | * @param mixed $field_id Field (or group field) ID |
||
980 | * @param mixed $field_args Array of field arguments |
||
981 | * @param mixed $sub_field_id Sub field ID (if field_group exists) |
||
982 | * @param CMB2_Field|null $field_group If a sub-field, will be the parent group CMB2_Field object |
||
983 | * @return array Array of CMB2_Field arguments |
||
984 | */ |
||
985 | 13 | public function get_field_args( $field_id, $field_args, $sub_field_id, $field_group ) { |
|
986 | |||
987 | // Check if group is passed and if fields were added in the old-school fields array |
||
988 | 13 | if ( $field_group && ( $sub_field_id || 0 === $sub_field_id ) ) { |
|
989 | |||
990 | // Update the fields array w/ any modified properties inherited from the group field |
||
991 | 2 | $this->meta_box['fields'][ $field_id ]['fields'][ $sub_field_id ] = $field_args; |
|
992 | |||
993 | 2 | return $this->get_default_args( $field_args, $field_group ); |
|
994 | } |
||
995 | |||
996 | 13 | if ( is_array( $field_args ) ) { |
|
997 | 2 | $this->meta_box['fields'][ $field_id ] = array_merge( $field_args, $this->meta_box['fields'][ $field_id ] ); |
|
998 | 2 | } |
|
999 | |||
1000 | 13 | return $this->get_default_args( $this->meta_box['fields'][ $field_id ] ); |
|
1001 | } |
||
1002 | |||
1003 | /** |
||
1004 | * Get default field arguments specific to this CMB2 object. |
||
1005 | * @since 2.2.0 |
||
1006 | * @param array $field_args Metabox field config array. |
||
1007 | * @param CMB2_Field $field_group (optional) CMB2_Field object (group parent) |
||
1008 | * @return array Array of field arguments. |
||
1009 | */ |
||
1010 | 17 | View Code Duplication | protected function get_default_args( $field_args, $field_group = null ) { |
1011 | 17 | if ( $field_group ) { |
|
1012 | $args = array( |
||
1013 | 3 | 'field_args' => $field_args, |
|
1014 | 3 | 'group_field' => $field_group, |
|
1015 | 3 | ); |
|
1016 | 3 | } else { |
|
1017 | $args = array( |
||
1018 | 17 | 'field_args' => $field_args, |
|
1019 | 17 | 'object_type' => $this->object_type(), |
|
1020 | 17 | 'object_id' => $this->object_id(), |
|
1021 | 17 | 'cmb_id' => $this->cmb_id, |
|
1022 | 17 | ); |
|
1023 | } |
||
1024 | |||
1025 | 17 | return $args; |
|
1026 | } |
||
1027 | |||
1028 | /** |
||
1029 | * Get a new field object specific to this CMB2 object. |
||
1030 | * @since 2.2.0 |
||
1031 | * @param array $field_args Metabox field config array. |
||
1032 | * @param CMB2_Field $field_group (optional) CMB2_Field object (group parent) |
||
1033 | * @return CMB2_Field CMB2_Field object |
||
1034 | */ |
||
1035 | 5 | protected function get_new_field( $field_args, $field_group = null ) { |
|
1036 | 5 | return new CMB2_Field( $this->get_default_args( $field_args, $field_group ) ); |
|
1037 | } |
||
1038 | |||
1039 | /** |
||
1040 | * When fields are added in the old-school way, intitate them as they should be |
||
1041 | * @since 2.1.0 |
||
1042 | * @param array $fields Array of fields to add |
||
1043 | * @param mixed $parent_field_id Parent field id or null |
||
1044 | */ |
||
1045 | 43 | protected function add_fields( $fields, $parent_field_id = null ) { |
|
1063 | |||
1064 | /** |
||
1065 | * Add a field to the metabox |
||
1066 | * @since 2.0.0 |
||
1067 | * @param array $field Metabox field config array |
||
1068 | * @param int $position (optional) Position of metabox. 1 for first, etc |
||
1069 | * @return string|false Field id or false |
||
1070 | */ |
||
1071 | 45 | public function add_field( array $field, $position = 0 ) { |
|
1072 | 45 | if ( ! is_array( $field ) || ! array_key_exists( 'id', $field ) ) { |
|
1073 | return false; |
||
1074 | } |
||
1075 | |||
1076 | 45 | if ( 'oembed' === $field['type'] ) { |
|
1077 | // Initiate oembed Ajax hooks |
||
1078 | 1 | cmb2_ajax(); |
|
1079 | 1 | } |
|
1080 | |||
1081 | 45 | if ( isset( $field['column'] ) && false !== $field['column'] ) { |
|
1082 | $field = $this->define_field_column( $field ); |
||
1083 | } |
||
1084 | |||
1085 | 45 | if ( isset( $field['taxonomy'] ) && ! empty( $field['remove_default'] ) ) { |
|
1086 | $this->tax_metaboxes_to_remove[ $field['taxonomy'] ] = $field['taxonomy']; |
||
1087 | } |
||
1088 | |||
1089 | 45 | $this->_add_field_to_array( |
|
1090 | 45 | $field, |
|
1091 | 45 | $this->meta_box['fields'], |
|
1092 | $position |
||
1093 | 45 | ); |
|
1094 | |||
1095 | 45 | return $field['id']; |
|
1096 | } |
||
1097 | |||
1098 | /** |
||
1099 | * Defines a field's column if requesting to be show in admin columns. |
||
1100 | * @since 2.2.3 |
||
1101 | * @param array $field Metabox field config array. |
||
1102 | * @return array Modified metabox field config array. |
||
1103 | */ |
||
1104 | protected function define_field_column( array $field ) { |
||
1105 | $this->has_columns = true; |
||
1106 | |||
1107 | $column = is_array( $field['column'] ) ? $field['column'] : array(); |
||
1108 | |||
1109 | $field['column'] = wp_parse_args( $column, array( |
||
1110 | 'name' => isset( $field['name'] ) ? $field['name'] : '', |
||
1111 | 'position' => false, |
||
1112 | ) ); |
||
1113 | |||
1114 | return $field; |
||
1115 | } |
||
1116 | |||
1117 | /** |
||
1118 | * Add a field to a group |
||
1119 | * @since 2.0.0 |
||
1120 | * @param string $parent_field_id The field id of the group field to add the field |
||
1121 | * @param array $field Metabox field config array |
||
1122 | * @param int $position (optional) Position of metabox. 1 for first, etc |
||
1123 | * @return mixed Array of parent/field ids or false |
||
1124 | */ |
||
1125 | 3 | public function add_group_field( $parent_field_id, array $field, $position = 0 ) { |
|
1148 | |||
1149 | /** |
||
1150 | * Add a field array to a fields array in desired position |
||
1151 | * @since 2.0.2 |
||
1152 | * @param array $field Metabox field config array |
||
1153 | * @param array &$fields Array (passed by reference) to append the field (array) to |
||
1154 | * @param integer $position Optionally specify a position in the array to be inserted |
||
1155 | */ |
||
1156 | 45 | protected function _add_field_to_array( $field, &$fields, $position = 0 ) { |
|
1163 | |||
1164 | /** |
||
1165 | * Remove a field from the metabox |
||
1166 | * @since 2.0.0 |
||
1167 | * @param string $field_id The field id of the field to remove |
||
1168 | * @param string $parent_field_id (optional) The field id of the group field to remove field from |
||
1169 | * @return bool True if field was removed |
||
1170 | */ |
||
1171 | 2 | public function remove_field( $field_id, $parent_field_id = '' ) { |
|
1195 | |||
1196 | /** |
||
1197 | * Update or add a property to a field |
||
1198 | * @since 2.0.0 |
||
1199 | * @param string $field_id Field id |
||
1200 | * @param string $property Field property to set/update |
||
1201 | * @param mixed $value Value to set the field property |
||
1202 | * @param string $parent_field_id (optional) The field id of the group field to remove field from |
||
1203 | * @return mixed Field id. Strict compare to false, as success can return a falsey value (like 0) |
||
1204 | */ |
||
1205 | 4 | public function update_field_property( $field_id, $property, $value, $parent_field_id = '' ) { |
|
1222 | |||
1223 | /** |
||
1224 | * Check if field ids match a field and return the index/field id |
||
1225 | * @since 2.0.2 |
||
1226 | * @param string $field_id Field id |
||
1227 | * @param string $parent_field_id (optional) Parent field id |
||
1228 | * @return mixed Array of field/parent ids, or false |
||
1229 | */ |
||
1230 | 19 | public function get_field_ids( $field_id, $parent_field_id = '' ) { |
|
1257 | |||
1258 | /** |
||
1259 | * When using the old array filter, it is unlikely field array indexes will be the field id |
||
1260 | * @since 2.0.2 |
||
1261 | * @param string $field_id The field id |
||
1262 | * @param array $fields Array of fields to search |
||
1263 | * @return mixed Field index or false |
||
1264 | */ |
||
1265 | 2 | public function search_old_school_array( $field_id, $fields ) { |
|
1270 | |||
1271 | /** |
||
1272 | * Handles metabox property callbacks, and passes this $cmb object as property. |
||
1273 | * @since 2.2.3 |
||
1274 | * @param callable $cb The callback method/function/closure |
||
1275 | * @return mixed Return of the callback function. |
||
1276 | */ |
||
1277 | 1 | protected function do_callback( $cb ) { |
|
1278 | 1 | return call_user_func( $cb, $this ); |
|
1279 | } |
||
1280 | |||
1281 | /** |
||
1282 | * Generate a unique nonce field for each registered meta_box |
||
1283 | * @since 2.0.0 |
||
1284 | * @return string unique nonce hidden input |
||
1285 | */ |
||
1286 | 1 | public function nonce_field() { |
|
1289 | |||
1290 | /** |
||
1291 | * Generate a unique nonce for each registered meta_box |
||
1292 | * @since 2.0.0 |
||
1293 | * @return string unique nonce string |
||
1294 | */ |
||
1295 | 1 | public function nonce() { |
|
1296 | 1 | if ( $this->generated_nonce ) { |
|
1297 | 1 | return $this->generated_nonce; |
|
1298 | } |
||
1299 | 1 | $this->generated_nonce = sanitize_html_class( 'nonce_' . basename( __FILE__ ) . $this->cmb_id ); |
|
1300 | 1 | return $this->generated_nonce; |
|
1301 | } |
||
1302 | |||
1303 | /** |
||
1304 | * Magic getter for our object. |
||
1305 | * @param string $field |
||
1306 | * @throws Exception Throws an exception if the field is invalid. |
||
1307 | * @return mixed |
||
1308 | */ |
||
1309 | 46 | public function __get( $field ) { |
|
1310 | switch ( $field ) { |
||
1311 | 46 | case 'updated': |
|
1312 | 46 | case 'has_columns': |
|
1313 | 46 | case 'tax_metaboxes_to_remove': |
|
1314 | 1 | return $this->{$field}; |
|
1315 | 46 | default: |
|
1316 | 46 | return parent::__get( $field ); |
|
1317 | 46 | } |
|
1319 | |||
1320 | } |
||
1321 |
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.