WebDevStudios /
CMB2
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 | 'type' => '', |
||
| 56 | 'object_types' => array(), // Post type |
||
| 57 | 'context' => 'normal', |
||
| 58 | 'priority' => 'high', |
||
| 59 | 'show_names' => true, // Show field names on the left |
||
| 60 | 'show_on_cb' => null, // Callback to determine if metabox should display. |
||
| 61 | 'show_on' => array(), // Post IDs or page templates to display this metabox. overrides 'show_on_cb' |
||
| 62 | 'cmb_styles' => true, // Include CMB2 stylesheet |
||
| 63 | 'enqueue_js' => true, // Include CMB2 JS |
||
| 64 | 'fields' => array(), |
||
| 65 | 'hookup' => true, |
||
| 66 | 'save_fields' => true, // Will not save during hookup if false |
||
| 67 | 'closed' => false, // Default to metabox being closed? |
||
| 68 | 'taxonomies' => array(), |
||
| 69 | 'new_user_section' => 'add-new-user', // or 'add-existing-user' |
||
| 70 | 'new_term_section' => true, |
||
| 71 | 'show_in_rest' => false, |
||
| 72 | ); |
||
| 73 | |||
| 74 | /** |
||
| 75 | * Metabox field objects |
||
| 76 | * @var array |
||
| 77 | * @since 2.0.3 |
||
| 78 | */ |
||
| 79 | protected $fields = array(); |
||
| 80 | |||
| 81 | /** |
||
| 82 | * An array of hidden fields to output at the end of the form |
||
| 83 | * @var array |
||
| 84 | * @since 2.0.0 |
||
| 85 | */ |
||
| 86 | protected $hidden_fields = array(); |
||
| 87 | |||
| 88 | /** |
||
| 89 | * Array of key => value data for saving. Likely $_POST data. |
||
| 90 | * @var string |
||
| 91 | * @since 2.0.0 |
||
| 92 | */ |
||
| 93 | protected $generated_nonce = ''; |
||
| 94 | |||
| 95 | /** |
||
| 96 | * Whether there are fields to be shown in columns. Set in CMB2::add_field(). |
||
| 97 | * @var bool |
||
| 98 | * @since 2.2.2 |
||
| 99 | */ |
||
| 100 | protected $has_columns = false; |
||
| 101 | |||
| 102 | /** |
||
| 103 | * If taxonomy field is requesting to remove_default, we store the taxonomy here. |
||
| 104 | * @var array |
||
| 105 | * @since 2.2.3 |
||
| 106 | */ |
||
| 107 | protected $tax_metaboxes_to_remove = array(); |
||
| 108 | |||
| 109 | /** |
||
| 110 | * Get started |
||
| 111 | * @since 0.4.0 |
||
| 112 | * @param array $config Metabox config array |
||
| 113 | * @param integer $object_id Optional object id |
||
| 114 | */ |
||
| 115 | 46 | public function __construct( $config, $object_id = 0 ) { |
|
| 116 | |||
| 117 | 46 | if ( empty( $config['id'] ) ) { |
|
| 118 | 1 | wp_die( esc_html__( 'Metabox configuration is required to have an ID parameter.', 'cmb2' ) ); |
|
| 119 | } |
||
| 120 | |||
| 121 | 46 | $this->meta_box = wp_parse_args( $config, $this->mb_defaults ); |
|
| 122 | 46 | $this->meta_box['fields'] = array(); |
|
| 123 | |||
| 124 | 46 | $this->object_id( $object_id ); |
|
| 125 | 46 | $this->mb_object_type(); |
|
| 126 | 46 | $this->cmb_id = $config['id']; |
|
| 127 | |||
| 128 | 46 | if ( ! empty( $config['fields'] ) && is_array( $config['fields'] ) ) { |
|
| 129 | 43 | $this->add_fields( $config['fields'] ); |
|
| 130 | 43 | } |
|
| 131 | |||
| 132 | 46 | CMB2_Boxes::add( $this ); |
|
| 133 | |||
| 134 | /** |
||
| 135 | * Hook during initiation of CMB2 object |
||
| 136 | * |
||
| 137 | * The dynamic portion of the hook name, $this->cmb_id, is this meta_box id. |
||
| 138 | * |
||
| 139 | * @param array $cmb This CMB2 object |
||
| 140 | */ |
||
| 141 | 46 | do_action( "cmb2_init_{$this->cmb_id}", $this ); |
|
| 142 | 46 | } |
|
| 143 | |||
| 144 | /** |
||
| 145 | * Loops through and displays fields |
||
| 146 | * @since 1.0.0 |
||
| 147 | * @param int $object_id Object ID |
||
| 148 | * @param string $object_type Type of object being saved. (e.g., post, user, or comment) |
||
| 149 | */ |
||
| 150 | 1 | public function show_form( $object_id = 0, $object_type = '' ) { |
|
| 151 | 1 | $this->render_form_open( $object_id, $object_type ); |
|
| 152 | |||
| 153 | 1 | foreach ( $this->prop( 'fields' ) as $field_args ) { |
|
| 154 | 1 | $this->render_field( $field_args ); |
|
| 155 | 1 | } |
|
| 156 | |||
| 157 | 1 | $this->render_form_close( $object_id, $object_type ); |
|
| 158 | 1 | } |
|
| 159 | |||
| 160 | /** |
||
| 161 | * Outputs the opening form markup and runs corresponding hooks: |
||
| 162 | * 'cmb2_before_form' and "cmb2_before_{$object_type}_form_{$this->cmb_id}" |
||
| 163 | * @since 2.2.0 |
||
| 164 | * @param integer $object_id Object ID |
||
| 165 | * @param string $object_type Object type |
||
| 166 | * @return void |
||
| 167 | */ |
||
| 168 | 1 | public function render_form_open( $object_id = 0, $object_type = '' ) { |
|
| 169 | 1 | $object_type = $this->object_type( $object_type ); |
|
| 170 | 1 | $object_id = $this->object_id( $object_id ); |
|
| 171 | |||
| 172 | 1 | echo "\n<!-- Begin CMB2 Fields -->\n"; |
|
| 173 | |||
| 174 | 1 | $this->nonce_field(); |
|
| 175 | |||
| 176 | /** |
||
| 177 | * Hook before form table begins |
||
| 178 | * |
||
| 179 | * @param array $cmb_id The current box ID |
||
| 180 | * @param int $object_id The ID of the current object |
||
| 181 | * @param string $object_type The type of object you are working with. |
||
| 182 | * Usually `post` (this applies to all post-types). |
||
| 183 | * Could also be `comment`, `user` or `options-page`. |
||
| 184 | * @param array $cmb This CMB2 object |
||
| 185 | */ |
||
| 186 | 1 | do_action( 'cmb2_before_form', $this->cmb_id, $object_id, $object_type, $this ); |
|
| 187 | |||
| 188 | /** |
||
| 189 | * Hook before form table begins |
||
| 190 | * |
||
| 191 | * The first dynamic portion of the hook name, $object_type, is the type of object |
||
| 192 | * you are working with. Usually `post` (this applies to all post-types). |
||
| 193 | * Could also be `comment`, `user` or `options-page`. |
||
| 194 | * |
||
| 195 | * The second dynamic portion of the hook name, $this->cmb_id, is the meta_box id. |
||
| 196 | * |
||
| 197 | * @param array $cmb_id The current box ID |
||
| 198 | * @param int $object_id The ID of the current object |
||
| 199 | * @param array $cmb This CMB2 object |
||
| 200 | */ |
||
| 201 | 1 | do_action( "cmb2_before_{$object_type}_form_{$this->cmb_id}", $object_id, $this ); |
|
| 202 | |||
| 203 | 1 | echo '<div class="', $this->box_classes(), '"><div id="cmb2-metabox-', sanitize_html_class( $this->cmb_id ), '" class="cmb2-metabox cmb-field-list">'; |
|
| 204 | |||
| 205 | 1 | } |
|
| 206 | |||
| 207 | /** |
||
| 208 | * Defines the classes for the CMB2 form/wrap. |
||
| 209 | * |
||
| 210 | * @since 2.0.0 |
||
| 211 | * @return string Space concatenated list of classes |
||
| 212 | */ |
||
| 213 | 1 | public function box_classes() { |
|
| 214 | |||
| 215 | 1 | $classes = array( 'cmb2-wrap', 'form-table' ); |
|
| 216 | |||
| 217 | // Use the callback to fetch classes. |
||
| 218 | 1 | View Code Duplication | if ( $added_classes = $this->get_param_callback_result( 'classes_cb' ) ) { |
| 219 | 1 | $added_classes = is_array( $added_classes ) ? $added_classes : array( $added_classes ); |
|
| 220 | 1 | $classes = array_merge( $classes, $added_classes ); |
|
| 221 | 1 | } |
|
| 222 | |||
| 223 | 1 | View Code Duplication | if ( $added_classes = $this->prop( 'classes' ) ) { |
| 224 | 1 | $added_classes = is_array( $added_classes ) ? $added_classes : array( $added_classes ); |
|
| 225 | 1 | $classes = array_merge( $classes, $added_classes ); |
|
| 226 | 1 | } |
|
| 227 | |||
| 228 | /** |
||
| 229 | * Globally filter box wrap classes |
||
| 230 | * |
||
| 231 | * @since 2.2.2 |
||
| 232 | * |
||
| 233 | * @param string $classes Array of classes for the cmb2-wrap. |
||
| 234 | * @param CMB2 $cmb This CMB2 object. |
||
| 235 | */ |
||
| 236 | 1 | $classes = apply_filters( 'cmb2_wrap_classes', $classes, $this ); |
|
| 237 | |||
| 238 | // Clean up. |
||
| 239 | 1 | $classes = array_map( 'strip_tags', array_filter( $classes ) ); |
|
| 240 | |||
| 241 | // Make a string. |
||
| 242 | 1 | return implode( ' ', $classes ); |
|
| 243 | } |
||
| 244 | |||
| 245 | /** |
||
| 246 | * Outputs the closing form markup and runs corresponding hooks: |
||
| 247 | * 'cmb2_after_form' and "cmb2_after_{$object_type}_form_{$this->cmb_id}" |
||
| 248 | * @since 2.2.0 |
||
| 249 | * @param integer $object_id Object ID |
||
| 250 | * @param string $object_type Object type |
||
| 251 | * @return void |
||
| 252 | */ |
||
| 253 | 1 | public function render_form_close( $object_id = 0, $object_type = '' ) { |
|
| 290 | |||
| 291 | /** |
||
| 292 | * Renders a field based on the field type |
||
| 293 | * @since 2.2.0 |
||
| 294 | * @param array $field_args A field configuration array. |
||
| 295 | * @return mixed CMB2_Field object if successful. |
||
| 296 | */ |
||
| 297 | 1 | public function render_field( $field_args ) { |
|
| 321 | |||
| 322 | /** |
||
| 323 | * Render a repeatable group. |
||
| 324 | * @param array $args Array of field arguments for a group field parent. |
||
| 325 | * @return CMB2_Field|null Group field object. |
||
| 326 | */ |
||
| 327 | 2 | public function render_group( $args ) { |
|
| 328 | |||
| 329 | 2 | if ( ! isset( $args['id'], $args['fields'] ) || ! is_array( $args['fields'] ) ) { |
|
| 330 | return; |
||
| 331 | } |
||
| 332 | |||
| 333 | 2 | $field_group = $this->get_field( $args ); |
|
| 334 | |||
| 335 | // If field is requesting to be conditionally shown |
||
| 336 | 2 | if ( ! $field_group || ! $field_group->should_show() ) { |
|
| 337 | return; |
||
| 338 | } |
||
| 339 | |||
| 340 | 2 | $desc = $field_group->args( 'description' ); |
|
| 341 | 2 | $label = $field_group->args( 'name' ); |
|
| 342 | 2 | $group_val = (array) $field_group->value(); |
|
| 343 | 2 | $remove_disabled = count( $group_val ) <= 1 ? 'disabled="disabled" ' : ''; |
|
| 344 | 2 | $field_group->index = 0; |
|
| 345 | |||
| 346 | 2 | $field_group->peform_param_callback( 'before_group' ); |
|
| 347 | |||
| 348 | 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 ), '>'; |
|
| 349 | |||
| 350 | 2 | if ( $desc || $label ) { |
|
| 351 | 2 | $class = $desc ? ' cmb-group-description' : ''; |
|
| 352 | 2 | echo '<div class="cmb-row', $class, '"><div class="cmb-th">'; |
|
| 353 | 2 | if ( $label ) { |
|
| 354 | 2 | echo '<h2 class="cmb-group-name">', $label, '</h2>'; |
|
| 355 | 2 | } |
|
| 356 | 2 | if ( $desc ) { |
|
| 357 | 1 | echo '<p class="cmb2-metabox-description">', $desc, '</p>'; |
|
| 358 | 1 | } |
|
| 359 | 2 | echo '</div></div>'; |
|
| 360 | 2 | } |
|
| 361 | |||
| 362 | 2 | if ( ! empty( $group_val ) ) { |
|
| 363 | foreach ( $group_val as $group_key => $field_id ) { |
||
| 364 | $this->render_group_row( $field_group, $remove_disabled ); |
||
| 365 | $field_group->index++; |
||
| 366 | } |
||
| 367 | } else { |
||
| 368 | 2 | $this->render_group_row( $field_group, $remove_disabled ); |
|
| 369 | } |
||
| 370 | |||
| 371 | 2 | if ( $field_group->args( 'repeatable' ) ) { |
|
| 372 | 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>'; |
|
| 373 | 1 | } |
|
| 374 | |||
| 375 | 2 | echo '</div></div></div>'; |
|
| 376 | |||
| 377 | 2 | $field_group->peform_param_callback( 'after_group' ); |
|
| 378 | |||
| 379 | 2 | return $field_group; |
|
| 380 | } |
||
| 381 | |||
| 382 | /** |
||
| 383 | * Get the group wrap attributes, which are passed through a filter. |
||
| 384 | * @since 2.2.3 |
||
| 385 | * @param CMB2_Field $field_group The group CMB2_Field object. |
||
| 386 | * @return string The attributes string. |
||
| 387 | */ |
||
| 388 | 2 | public function group_wrap_attributes( $field_group ) { |
|
| 389 | 2 | $classes = 'cmb-nested cmb-field-list cmb-repeatable-group'; |
|
| 390 | 2 | $classes .= $field_group->options( 'sortable' ) ? ' sortable' : ' non-sortable'; |
|
| 391 | 2 | $classes .= $field_group->args( 'repeatable' ) ? ' repeatable' : ' non-repeatable'; |
|
| 392 | |||
| 393 | $group_wrap_attributes = array( |
||
| 394 | 2 | 'class' => $classes, |
|
| 395 | 2 | 'style' => 'width:100%;', |
|
| 396 | 2 | ); |
|
| 397 | |||
| 398 | /** |
||
| 399 | * Allow for adding additional HTML attributes to a group wrapper. |
||
| 400 | * |
||
| 401 | * The attributes will be an array of key => value pairs for each attribute. |
||
| 402 | * |
||
| 403 | * @since 2.2.2 |
||
| 404 | * |
||
| 405 | * @param string $group_wrap_attributes Current attributes array. |
||
| 406 | * |
||
| 407 | * @param CMB2_Field $field_group The group CMB2_Field object. |
||
| 408 | */ |
||
| 409 | 2 | $group_wrap_attributes = apply_filters( 'cmb2_group_wrap_attributes', $group_wrap_attributes, $field_group ); |
|
| 410 | |||
| 411 | 2 | return CMB2_Utils::concat_attrs( $group_wrap_attributes ); |
|
| 412 | } |
||
| 413 | |||
| 414 | /** |
||
| 415 | * Render a repeatable group row |
||
| 416 | * @since 1.0.2 |
||
| 417 | * @param CMB2_Field $field_group CMB2_Field group field object |
||
| 418 | * @param string $remove_disabled Attribute string to disable the remove button |
||
| 419 | */ |
||
| 420 | 2 | public function render_group_row( $field_group, $remove_disabled ) { |
|
| 468 | |||
| 469 | /** |
||
| 470 | * Add a hidden field to the list of hidden fields to be rendered later |
||
| 471 | * @since 2.0.0 |
||
| 472 | * @param array $field_args Array of field arguments to be passed to CMB2_Field |
||
| 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 | 2 | public function get_sanitized_values( array $data_to_sanitize ) { |
|
| 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 array $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 | |||
| 700 | 1 | $field = $this->get_new_field( $field_args, $field_group ); |
|
| 701 | 1 | $sub_id = $field->id( true ); |
|
| 702 | |||
| 703 | 1 | foreach ( (array) $group_vals as $field_group->index => $post_vals ) { |
|
| 704 | |||
| 705 | // Get value |
||
| 706 | 1 | $new_val = isset( $group_vals[ $field_group->index ][ $sub_id ] ) |
|
| 707 | 1 | ? $group_vals[ $field_group->index ][ $sub_id ] |
|
| 708 | 1 | : false; |
|
| 709 | |||
| 710 | // Sanitize |
||
| 711 | 1 | $new_val = $field->sanitization_cb( $new_val ); |
|
| 712 | |||
| 713 | 1 | if ( is_array( $new_val ) && $field->args( 'has_supporting_data' ) ) { |
|
| 714 | 1 | if ( $field->args( 'repeatable' ) ) { |
|
| 715 | 1 | $_new_val = array(); |
|
| 716 | 1 | foreach ( $new_val as $group_index => $grouped_data ) { |
|
| 717 | // Add the supporting data to the $saved array stack |
||
| 718 | 1 | $saved[ $field_group->index ][ $grouped_data['supporting_field_id'] ][] = $grouped_data['supporting_field_value']; |
|
| 719 | // Reset var to the actual value |
||
| 720 | 1 | $_new_val[ $group_index ] = $grouped_data['value']; |
|
| 721 | 1 | } |
|
| 722 | 1 | $new_val = $_new_val; |
|
| 723 | 1 | } else { |
|
| 724 | // Add the supporting data to the $saved array stack |
||
| 725 | 1 | $saved[ $field_group->index ][ $new_val['supporting_field_id'] ] = $new_val['supporting_field_value']; |
|
| 726 | // Reset var to the actual value |
||
| 727 | 1 | $new_val = $new_val['value']; |
|
| 728 | } |
||
| 729 | 1 | } |
|
| 730 | |||
| 731 | // Get old value |
||
| 732 | 1 | $old_val = is_array( $old ) && isset( $old[ $field_group->index ][ $sub_id ] ) |
|
| 733 | 1 | ? $old[ $field_group->index ][ $sub_id ] |
|
| 734 | 1 | : false; |
|
| 735 | |||
| 736 | 1 | $is_updated = ( ! CMB2_Utils::isempty( $new_val ) && $new_val !== $old_val ); |
|
| 737 | 1 | $is_removed = ( CMB2_Utils::isempty( $new_val ) && ! CMB2_Utils::isempty( $old_val ) ); |
|
| 738 | |||
| 739 | // Compare values and add to `$updated` array |
||
| 740 | 1 | if ( $is_updated || $is_removed ) { |
|
| 741 | 1 | $this->updated[] = $base_id . '::' . $field_group->index . '::' . $sub_id; |
|
| 742 | 1 | } |
|
| 743 | |||
| 744 | // Add to `$saved` array |
||
| 745 | 1 | $saved[ $field_group->index ][ $sub_id ] = $new_val; |
|
| 746 | |||
| 747 | 1 | } |
|
| 748 | |||
| 749 | 1 | $saved[ $field_group->index ] = CMB2_Utils::filter_empty( $saved[ $field_group->index ] ); |
|
| 750 | 1 | } |
|
| 751 | |||
| 752 | 1 | $saved = CMB2_Utils::filter_empty( $saved ); |
|
| 753 | |||
| 754 | 1 | return $field_group->update_data( $saved, true ); |
|
| 755 | } |
||
| 756 | |||
| 757 | /** |
||
| 758 | * Get object id from global space if no id is provided |
||
| 759 | * @since 1.0.0 |
||
| 760 | * @param integer $object_id Object ID |
||
| 761 | * @return integer $object_id Object ID |
||
| 762 | */ |
||
| 763 | 50 | public function object_id( $object_id = 0 ) { |
|
| 802 | |||
| 803 | /** |
||
| 804 | * Sets the $object_type based on metabox settings |
||
| 805 | * @since 1.0.0 |
||
| 806 | * @return string Object type |
||
| 807 | */ |
||
| 808 | 46 | public function mb_object_type() { |
|
| 809 | 46 | if ( null !== $this->mb_object_type ) { |
|
| 810 | 12 | return $this->mb_object_type; |
|
| 811 | } |
||
| 812 | |||
| 813 | 46 | if ( $this->is_options_page_mb() ) { |
|
| 814 | 38 | $this->mb_object_type = 'options-page'; |
|
| 815 | 38 | return $this->mb_object_type; |
|
| 816 | } |
||
| 848 | |||
| 849 | /** |
||
| 850 | * Gets the box 'object_types' array based on box settings. |
||
| 851 | * @since 2.2.4 |
||
| 852 | * @return array Object types |
||
| 853 | */ |
||
| 854 | 45 | public function box_types() { |
|
| 857 | |||
| 858 | /** |
||
| 859 | * Determines if metabox is for an options page |
||
| 860 | * @since 1.0.1 |
||
| 861 | * @return boolean True/False |
||
| 862 | */ |
||
| 863 | 46 | public function is_options_page_mb() { |
|
| 866 | |||
| 867 | /** |
||
| 868 | * Returns the object type |
||
| 869 | * @since 1.0.0 |
||
| 870 | * @return string Object type |
||
| 871 | */ |
||
| 872 | 50 | public function object_type( $object_type = '' ) { |
|
| 886 | |||
| 887 | /** |
||
| 888 | * Get the object type for the current page, based on the $pagenow global. |
||
| 889 | * @since 2.2.2 |
||
| 890 | * @return string Page object type name. |
||
| 891 | */ |
||
| 892 | View Code Duplication | public function current_object_type() { |
|
| 910 | |||
| 911 | /** |
||
| 912 | * Set metabox property. |
||
| 913 | * @since 2.2.2 |
||
| 914 | * @param string $property Metabox config property to retrieve |
||
| 915 | * @param mixed $value Value to set if no value found |
||
| 916 | * @return mixed Metabox config property value or false |
||
| 917 | */ |
||
| 918 | 1 | public function set_prop( $property, $value ) { |
|
| 923 | |||
| 924 | /** |
||
| 925 | * Get metabox property and optionally set a fallback |
||
| 926 | * @since 2.0.0 |
||
| 927 | * @param string $property Metabox config property to retrieve |
||
| 928 | * @param mixed $fallback Fallback value to set if no value found |
||
| 929 | * @return mixed Metabox config property value or false |
||
| 930 | */ |
||
| 931 | 46 | public function prop( $property, $fallback = null ) { |
|
| 938 | |||
| 939 | /** |
||
| 940 | * Get a field object |
||
| 941 | * @since 2.0.3 |
||
| 942 | * @param string|array|CMB2_Field $field Metabox field id or field config array or CMB2_Field object |
||
| 943 | * @param CMB2_Field $field_group (optional) CMB2_Field object (group parent) |
||
| 944 | * @return CMB2_Field|false CMB2_Field object (or false) |
||
| 945 | */ |
||
| 946 | 15 | public function get_field( $field, $field_group = null ) { |
|
| 971 | |||
| 972 | /** |
||
| 973 | * Handles determining which type of arguments to pass to CMB2_Field |
||
| 974 | * @since 2.0.7 |
||
| 975 | * @param mixed $field_id Field (or group field) ID |
||
| 976 | * @param mixed $field_args Array of field arguments |
||
| 977 | * @param mixed $sub_field_id Sub field ID (if field_group exists) |
||
| 978 | * @param mixed $field_group If a sub-field, will be the parent group CMB2_Field object |
||
| 979 | * @return array Array of CMB2_Field arguments |
||
| 980 | */ |
||
| 981 | 13 | public function get_field_args( $field_id, $field_args, $sub_field_id, $field_group ) { |
|
| 998 | |||
| 999 | /** |
||
| 1000 | * Get default field arguments specific to this CMB2 object. |
||
| 1001 | * @since 2.2.0 |
||
| 1002 | * @param array $field_args Metabox field config array. |
||
| 1003 | * @param CMB2_Field $field_group (optional) CMB2_Field object (group parent) |
||
| 1004 | * @return array Array of field arguments. |
||
| 1005 | */ |
||
| 1006 | 17 | View Code Duplication | protected function get_default_args( $field_args, $field_group = null ) { |
| 1023 | |||
| 1024 | /** |
||
| 1025 | * Get a new field object specific to this CMB2 object. |
||
| 1026 | * @since 2.2.0 |
||
| 1027 | * @param array $field_args Metabox field config array. |
||
| 1028 | * @param CMB2_Field $field_group (optional) CMB2_Field object (group parent) |
||
| 1029 | * @return CMB2_Field CMB2_Field object |
||
| 1030 | */ |
||
| 1031 | 5 | protected function get_new_field( $field_args, $field_group = null ) { |
|
| 1034 | |||
| 1035 | /** |
||
| 1036 | * When fields are added in the old-school way, intitate them as they should be |
||
| 1037 | * @since 2.1.0 |
||
| 1038 | * @param array $fields Array of fields to add |
||
| 1039 | * @param mixed $parent_field_id Parent field id or null |
||
| 1040 | */ |
||
| 1041 | 43 | protected function add_fields( $fields, $parent_field_id = null ) { |
|
| 1059 | |||
| 1060 | /** |
||
| 1061 | * Add a field to the metabox |
||
| 1062 | * @since 2.0.0 |
||
| 1063 | * @param array $field Metabox field config array |
||
| 1064 | * @param int $position (optional) Position of metabox. 1 for first, etc |
||
| 1065 | * @return mixed Field id or false |
||
| 1066 | */ |
||
| 1067 | 45 | public function add_field( array $field, $position = 0 ) { |
|
| 1093 | |||
| 1094 | /** |
||
| 1095 | * Defines a field's column if requesting to be show in admin columns. |
||
| 1096 | * @since 2.2.3 |
||
| 1097 | * @param array $field Metabox field config array. |
||
| 1098 | * @return array Modified metabox field config array. |
||
| 1099 | */ |
||
| 1100 | protected function define_field_column( array $field ) { |
||
| 1112 | |||
| 1113 | /** |
||
| 1114 | * Add a field to a group |
||
| 1115 | * @since 2.0.0 |
||
| 1116 | * @param string $parent_field_id The field id of the group field to add the field |
||
| 1117 | * @param array $field Metabox field config array |
||
| 1118 | * @param int $position (optional) Position of metabox. 1 for first, etc |
||
| 1119 | * @return mixed Array of parent/field ids or false |
||
| 1120 | */ |
||
| 1121 | 3 | public function add_group_field( $parent_field_id, array $field, $position = 0 ) { |
|
| 1144 | |||
| 1145 | /** |
||
| 1146 | * Add a field array to a fields array in desired position |
||
| 1147 | * @since 2.0.2 |
||
| 1148 | * @param array $field Metabox field config array |
||
| 1149 | * @param array &$fields Array (passed by reference) to append the field (array) to |
||
| 1150 | * @param integer $position Optionally specify a position in the array to be inserted |
||
| 1151 | */ |
||
| 1152 | 45 | protected function _add_field_to_array( $field, &$fields, $position = 0 ) { |
|
| 1159 | |||
| 1160 | /** |
||
| 1161 | * Remove a field from the metabox |
||
| 1162 | * @since 2.0.0 |
||
| 1163 | * @param string $field_id The field id of the field to remove |
||
| 1164 | * @param string $parent_field_id (optional) The field id of the group field to remove field from |
||
| 1165 | * @return bool True if field was removed |
||
| 1166 | */ |
||
| 1167 | 2 | public function remove_field( $field_id, $parent_field_id = '' ) { |
|
| 1191 | |||
| 1192 | /** |
||
| 1193 | * Update or add a property to a field |
||
| 1194 | * @since 2.0.0 |
||
| 1195 | * @param string $field_id Field id |
||
| 1196 | * @param string $property Field property to set/update |
||
| 1197 | * @param mixed $value Value to set the field property |
||
| 1198 | * @param string $parent_field_id (optional) The field id of the group field to remove field from |
||
| 1199 | * @return mixed Field id. Strict compare to false, as success can return a falsey value (like 0) |
||
| 1200 | */ |
||
| 1201 | 4 | public function update_field_property( $field_id, $property, $value, $parent_field_id = '' ) { |
|
| 1218 | |||
| 1219 | /** |
||
| 1220 | * Check if field ids match a field and return the index/field id |
||
| 1221 | * @since 2.0.2 |
||
| 1222 | * @param string $field_id Field id |
||
| 1223 | * @param string $parent_field_id (optional) Parent field id |
||
| 1224 | * @return mixed Array of field/parent ids, or false |
||
| 1225 | */ |
||
| 1226 | 19 | public function get_field_ids( $field_id, $parent_field_id = '' ) { |
|
| 1253 | |||
| 1254 | /** |
||
| 1255 | * When using the old array filter, it is unlikely field array indexes will be the field id |
||
| 1256 | * @since 2.0.2 |
||
| 1257 | * @param string $field_id The field id |
||
| 1258 | * @param array $fields Array of fields to search |
||
| 1259 | * @return mixed Field index or false |
||
| 1260 | */ |
||
| 1261 | 2 | public function search_old_school_array( $field_id, $fields ) { |
|
| 1266 | |||
| 1267 | /** |
||
| 1268 | * Handles metabox property callbacks, and passes this $cmb object as property. |
||
| 1269 | * @since 2.2.3 |
||
| 1270 | * @param callable $cb The callback method/function/closure |
||
| 1271 | * @return mixed Return of the callback function. |
||
| 1272 | */ |
||
| 1273 | 1 | protected function do_callback( $cb ) { |
|
| 1276 | |||
| 1277 | /** |
||
| 1278 | * Generate a unique nonce field for each registered meta_box |
||
| 1279 | * @since 2.0.0 |
||
| 1280 | * @return string unique nonce hidden input |
||
| 1281 | */ |
||
| 1282 | 1 | public function nonce_field() { |
|
| 1285 | |||
| 1286 | /** |
||
| 1287 | * Generate a unique nonce for each registered meta_box |
||
| 1288 | * @since 2.0.0 |
||
| 1289 | * @return string unique nonce string |
||
| 1290 | */ |
||
| 1291 | 1 | public function nonce() { |
|
| 1298 | |||
| 1299 | /** |
||
| 1300 | * Magic getter for our object. |
||
| 1301 | * @param string $field |
||
| 1302 | * @throws Exception Throws an exception if the field is invalid. |
||
| 1303 | * @return mixed |
||
| 1304 | */ |
||
| 1305 | 46 | public function __get( $field ) { |
|
| 1315 | |||
| 1316 | } |
||
| 1317 |
Loading history...
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.