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 | 48 | public function __construct( $config, $object_id = 0 ) { |
|
115 | |||
116 | 48 | if ( empty( $config['id'] ) ) { |
|
117 | 1 | wp_die( esc_html__( 'Metabox configuration is required to have an ID parameter.', 'cmb2' ) ); |
|
118 | } |
||
119 | |||
120 | 48 | $this->meta_box = wp_parse_args( $config, $this->mb_defaults ); |
|
121 | 48 | $this->meta_box['fields'] = array(); |
|
122 | |||
123 | 48 | $this->object_id( $object_id ); |
|
124 | 48 | $this->mb_object_type(); |
|
125 | 48 | $this->cmb_id = $config['id']; |
|
126 | |||
127 | 48 | if ( ! empty( $config['fields'] ) && is_array( $config['fields'] ) ) { |
|
128 | 45 | $this->add_fields( $config['fields'] ); |
|
129 | 45 | } |
|
130 | |||
131 | 48 | 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 | 48 | do_action( "cmb2_init_{$this->cmb_id}", $this ); |
|
141 | 48 | } |
|
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() { |
|
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 | 4 | public function get_sanitized_values( array $data_to_sanitize ) { |
|
511 | 4 | $this->data_to_save = $data_to_sanitize; |
|
512 | 4 | $stored_id = $this->object_id(); |
|
513 | |||
540 | |||
541 | /** |
||
542 | * Loops through and saves field data |
||
543 | * @since 1.0.0 |
||
544 | * @param int $object_id Object ID |
||
545 | * @param string $object_type Type of object being saved. (e.g., post, user, or comment) |
||
546 | * @param array $data_to_save Array of key => value data for saving. Likely $_POST data. |
||
547 | */ |
||
548 | 1 | public function save_fields( $object_id = 0, $object_type = '', $data_to_save = array() ) { |
|
564 | |||
565 | /** |
||
566 | * Process and save form fields |
||
567 | * @since 2.0.0 |
||
568 | */ |
||
569 | 5 | public function process_fields() { |
|
583 | |||
584 | /** |
||
585 | * Process and save a field |
||
586 | * @since 2.0.0 |
||
587 | * @param array $field_args Array of field arguments |
||
588 | */ |
||
589 | 5 | public function process_field( $field_args ) { |
|
616 | |||
617 | 5 | public function pre_process() { |
|
632 | |||
633 | 1 | public function after_save() { |
|
668 | |||
669 | /** |
||
670 | * Save a repeatable group |
||
671 | * @since 1.x.x |
||
672 | * @param array $args Field arguments array |
||
673 | * @return mixed Return of CMB2_Field::update_data() |
||
674 | */ |
||
675 | 2 | public function save_group( $args ) { |
|
682 | |||
683 | /** |
||
684 | * Save a repeatable group |
||
685 | * @since 1.x.x |
||
686 | * @param CMB2_Field $field_group CMB2_Field group field object |
||
687 | * @return mixed Return of CMB2_Field::update_data() |
||
688 | */ |
||
689 | 2 | public function save_group_field( $field_group ) { |
|
766 | |||
767 | /** |
||
768 | * Get object id from global space if no id is provided |
||
769 | * @since 1.0.0 |
||
770 | * @param integer $object_id Object ID |
||
771 | * @return integer $object_id Object ID |
||
772 | */ |
||
773 | 52 | public function object_id( $object_id = 0 ) { |
|
812 | |||
813 | /** |
||
814 | * Sets the $object_type based on metabox settings |
||
815 | * @since 1.0.0 |
||
816 | * @return string Object type |
||
817 | */ |
||
818 | 48 | public function mb_object_type() { |
|
858 | |||
859 | /** |
||
860 | * Gets the box 'object_types' array based on box settings. |
||
861 | * @since 2.2.3 |
||
862 | * @return array Object types |
||
863 | */ |
||
864 | 47 | public function box_types() { |
|
867 | |||
868 | /** |
||
869 | * Determines if metabox is for an options page |
||
870 | * @since 1.0.1 |
||
871 | * @return boolean True/False |
||
872 | */ |
||
873 | 48 | public function is_options_page_mb() { |
|
876 | |||
877 | /** |
||
878 | * Returns the object type |
||
879 | * @since 1.0.0 |
||
880 | * @return string Object type |
||
881 | */ |
||
882 | 52 | public function object_type( $object_type = '' ) { |
|
896 | |||
897 | /** |
||
898 | * Get the object type for the current page, based on the $pagenow global. |
||
899 | * @since 2.2.2 |
||
900 | * @return string Page object type name. |
||
901 | */ |
||
902 | 47 | View Code Duplication | public function current_object_type() { |
920 | |||
921 | /** |
||
922 | * Set metabox property. |
||
923 | * @since 2.2.2 |
||
924 | * @param string $property Metabox config property to retrieve |
||
925 | * @param mixed $value Value to set if no value found |
||
926 | * @return mixed Metabox config property value or false |
||
927 | */ |
||
928 | 1 | public function set_prop( $property, $value ) { |
|
933 | |||
934 | /** |
||
935 | * Get metabox property and optionally set a fallback |
||
936 | * @since 2.0.0 |
||
937 | * @param string $property Metabox config property to retrieve |
||
938 | * @param mixed $fallback Fallback value to set if no value found |
||
939 | * @return mixed Metabox config property value or false |
||
940 | */ |
||
941 | 48 | public function prop( $property, $fallback = null ) { |
|
948 | |||
949 | /** |
||
950 | * Get a field object |
||
951 | * @since 2.0.3 |
||
952 | * @param string|array|CMB2_Field $field Metabox field id or field config array or CMB2_Field object |
||
953 | * @param CMB2_Field|null $field_group (optional) CMB2_Field object (group parent) |
||
954 | * @return CMB2_Field|false CMB2_Field object (or false) |
||
955 | */ |
||
956 | 15 | public function get_field( $field, $field_group = null ) { |
|
981 | |||
982 | /** |
||
983 | * Handles determining which type of arguments to pass to CMB2_Field |
||
984 | * @since 2.0.7 |
||
985 | * @param mixed $field_id Field (or group field) ID |
||
986 | * @param mixed $field_args Array of field arguments |
||
987 | * @param mixed $sub_field_id Sub field ID (if field_group exists) |
||
988 | * @param CMB2_Field|null $field_group If a sub-field, will be the parent group CMB2_Field object |
||
989 | * @return array Array of CMB2_Field arguments |
||
990 | */ |
||
991 | 13 | public function get_field_args( $field_id, $field_args, $sub_field_id, $field_group ) { |
|
1008 | |||
1009 | /** |
||
1010 | * Get default field arguments specific to this CMB2 object. |
||
1011 | * @since 2.2.0 |
||
1012 | * @param array $field_args Metabox field config array. |
||
1013 | * @param CMB2_Field $field_group (optional) CMB2_Field object (group parent) |
||
1014 | * @return array Array of field arguments. |
||
1015 | */ |
||
1016 | 19 | View Code Duplication | protected function get_default_args( $field_args, $field_group = null ) { |
1033 | |||
1034 | /** |
||
1035 | * Get a new field object specific to this CMB2 object. |
||
1036 | * @since 2.2.0 |
||
1037 | * @param array $field_args Metabox field config array. |
||
1038 | * @param CMB2_Field $field_group (optional) CMB2_Field object (group parent) |
||
1039 | * @return CMB2_Field CMB2_Field object |
||
1040 | */ |
||
1041 | 7 | protected function get_new_field( $field_args, $field_group = null ) { |
|
1044 | |||
1045 | /** |
||
1046 | * When fields are added in the old-school way, intitate them as they should be |
||
1047 | * @since 2.1.0 |
||
1048 | * @param array $fields Array of fields to add |
||
1049 | * @param mixed $parent_field_id Parent field id or null |
||
1050 | */ |
||
1051 | 45 | protected function add_fields( $fields, $parent_field_id = null ) { |
|
1052 | 45 | foreach ( $fields as $field ) { |
|
1053 | |||
1054 | 45 | $sub_fields = false; |
|
1055 | 45 | if ( array_key_exists( 'fields', $field ) ) { |
|
1056 | 1 | $sub_fields = $field['fields']; |
|
1057 | 1 | unset( $field['fields'] ); |
|
1058 | 1 | } |
|
1059 | |||
1060 | $field_id = $parent_field_id |
||
1061 | 45 | ? $this->add_group_field( $parent_field_id, $field ) |
|
1062 | 45 | : $this->add_field( $field ); |
|
1063 | |||
1064 | 45 | if ( $sub_fields ) { |
|
1065 | 1 | $this->add_fields( $sub_fields, $field_id ); |
|
1066 | 1 | } |
|
1067 | 45 | } |
|
1068 | 45 | } |
|
1069 | |||
1070 | /** |
||
1071 | * Add a field to the metabox |
||
1072 | * @since 2.0.0 |
||
1073 | * @param array $field Metabox field config array |
||
1074 | * @param int $position (optional) Position of metabox. 1 for first, etc |
||
1075 | * @return string|false Field id or false |
||
1076 | */ |
||
1077 | 47 | public function add_field( array $field, $position = 0 ) { |
|
1103 | |||
1104 | /** |
||
1105 | * Defines a field's column if requesting to be show in admin columns. |
||
1106 | * @since 2.2.3 |
||
1107 | * @param array $field Metabox field config array. |
||
1108 | * @return array Modified metabox field config array. |
||
1109 | */ |
||
1110 | protected function define_field_column( array $field ) { |
||
1122 | |||
1123 | /** |
||
1124 | * Add a field to a group |
||
1125 | * @since 2.0.0 |
||
1126 | * @param string $parent_field_id The field id of the group field to add the field |
||
1127 | * @param array $field Metabox field config array |
||
1128 | * @param int $position (optional) Position of metabox. 1 for first, etc |
||
1129 | * @return mixed Array of parent/field ids or false |
||
1130 | */ |
||
1131 | 5 | public function add_group_field( $parent_field_id, array $field, $position = 0 ) { |
|
1154 | |||
1155 | /** |
||
1156 | * Add a field array to a fields array in desired position |
||
1157 | * @since 2.0.2 |
||
1158 | * @param array $field Metabox field config array |
||
1159 | * @param array &$fields Array (passed by reference) to append the field (array) to |
||
1160 | * @param integer $position Optionally specify a position in the array to be inserted |
||
1161 | */ |
||
1162 | 47 | protected function _add_field_to_array( $field, &$fields, $position = 0 ) { |
|
1169 | |||
1170 | /** |
||
1171 | * Remove a field from the metabox |
||
1172 | * @since 2.0.0 |
||
1173 | * @param string $field_id The field id of the field to remove |
||
1174 | * @param string $parent_field_id (optional) The field id of the group field to remove field from |
||
1175 | * @return bool True if field was removed |
||
1176 | */ |
||
1177 | 2 | public function remove_field( $field_id, $parent_field_id = '' ) { |
|
1201 | |||
1202 | /** |
||
1203 | * Update or add a property to a field |
||
1204 | * @since 2.0.0 |
||
1205 | * @param string $field_id Field id |
||
1206 | * @param string $property Field property to set/update |
||
1207 | * @param mixed $value Value to set the field property |
||
1208 | * @param string $parent_field_id (optional) The field id of the group field to remove field from |
||
1209 | * @return mixed Field id. Strict compare to false, as success can return a falsey value (like 0) |
||
1210 | */ |
||
1211 | 4 | public function update_field_property( $field_id, $property, $value, $parent_field_id = '' ) { |
|
1228 | |||
1229 | /** |
||
1230 | * Check if field ids match a field and return the index/field id |
||
1231 | * @since 2.0.2 |
||
1232 | * @param string $field_id Field id |
||
1233 | * @param string $parent_field_id (optional) Parent field id |
||
1234 | * @return mixed Array of field/parent ids, or false |
||
1235 | */ |
||
1236 | 19 | public function get_field_ids( $field_id, $parent_field_id = '' ) { |
|
1263 | |||
1264 | /** |
||
1265 | * When using the old array filter, it is unlikely field array indexes will be the field id |
||
1266 | * @since 2.0.2 |
||
1267 | * @param string $field_id The field id |
||
1268 | * @param array $fields Array of fields to search |
||
1269 | * @return mixed Field index or false |
||
1270 | */ |
||
1271 | 2 | public function search_old_school_array( $field_id, $fields ) { |
|
1276 | |||
1277 | /** |
||
1278 | * Handles metabox property callbacks, and passes this $cmb object as property. |
||
1279 | * @since 2.2.3 |
||
1280 | * @param callable $cb The callback method/function/closure |
||
1281 | * @return mixed Return of the callback function. |
||
1282 | */ |
||
1283 | 1 | protected function do_callback( $cb ) { |
|
1286 | |||
1287 | /** |
||
1288 | * Generate a unique nonce field for each registered meta_box |
||
1289 | * @since 2.0.0 |
||
1290 | * @return string unique nonce hidden input |
||
1291 | */ |
||
1292 | 1 | public function nonce_field() { |
|
1295 | |||
1296 | /** |
||
1297 | * Generate a unique nonce for each registered meta_box |
||
1298 | * @since 2.0.0 |
||
1299 | * @return string unique nonce string |
||
1300 | */ |
||
1301 | 1 | public function nonce() { |
|
1308 | |||
1309 | /** |
||
1310 | * Magic getter for our object. |
||
1311 | * @param string $field |
||
1312 | * @throws Exception Throws an exception if the field is invalid. |
||
1313 | * @return mixed |
||
1314 | */ |
||
1315 | 48 | public function __get( $field ) { |
|
1325 | |||
1326 | } |
||
1327 |
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.