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 |
||
| 15 | class CMB2 { |
||
|
|
|||
| 16 | |||
| 17 | /** |
||
| 18 | * Current field's ID |
||
| 19 | * @var string |
||
| 20 | * @since 2.0.0 |
||
| 21 | */ |
||
| 22 | protected $cmb_id = ''; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * Metabox Config array |
||
| 26 | * @var array |
||
| 27 | * @since 0.9.0 |
||
| 28 | */ |
||
| 29 | protected $meta_box = array(); |
||
| 30 | |||
| 31 | /** |
||
| 32 | * Object ID for metabox meta retrieving/saving |
||
| 33 | * @var mixed |
||
| 34 | * @since 1.0.0 |
||
| 35 | */ |
||
| 36 | protected $object_id = 0; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * Type of object being saved. (e.g., post, user, or comment) |
||
| 40 | * @var string |
||
| 41 | * @since 1.0.0 |
||
| 42 | */ |
||
| 43 | protected $object_type = 'post'; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * Type of object registered for metabox. (e.g., post, user, or comment) |
||
| 47 | * @var string |
||
| 48 | * @since 1.0.0 |
||
| 49 | */ |
||
| 50 | protected $mb_object_type = null; |
||
| 51 | |||
| 52 | /** |
||
| 53 | * List of fields that are changed/updated on save |
||
| 54 | * @var array |
||
| 55 | * @since 1.1.0 |
||
| 56 | */ |
||
| 57 | protected $updated = array(); |
||
| 58 | |||
| 59 | /** |
||
| 60 | * Metabox Defaults |
||
| 61 | * @var array |
||
| 62 | * @since 1.0.1 |
||
| 63 | */ |
||
| 64 | protected $mb_defaults = array( |
||
| 65 | 'id' => '', |
||
| 66 | 'title' => '', |
||
| 67 | 'type' => '', |
||
| 68 | 'object_types' => array(), // Post type |
||
| 69 | 'context' => 'normal', |
||
| 70 | 'priority' => 'high', |
||
| 71 | 'show_names' => true, // Show field names on the left |
||
| 72 | 'show_on_cb' => null, // Callback to determine if metabox should display. |
||
| 73 | 'show_on' => array(), // Post IDs or page templates to display this metabox. overrides 'show_on_cb' |
||
| 74 | 'cmb_styles' => true, // Include CMB2 stylesheet |
||
| 75 | 'enqueue_js' => true, // Include CMB2 JS |
||
| 76 | 'fields' => array(), |
||
| 77 | 'hookup' => true, |
||
| 78 | 'save_fields' => true, // Will not save during hookup if false |
||
| 79 | 'closed' => false, // Default to metabox being closed? |
||
| 80 | 'taxonomies' => array(), |
||
| 81 | 'new_user_section' => 'add-new-user', // or 'add-existing-user' |
||
| 82 | 'new_term_section' => true, |
||
| 83 | ); |
||
| 84 | |||
| 85 | /** |
||
| 86 | * Metabox field objects |
||
| 87 | * @var array |
||
| 88 | * @since 2.0.3 |
||
| 89 | */ |
||
| 90 | protected $fields = array(); |
||
| 91 | |||
| 92 | /** |
||
| 93 | * An array of hidden fields to output at the end of the form |
||
| 94 | * @var array |
||
| 95 | * @since 2.0.0 |
||
| 96 | */ |
||
| 97 | protected $hidden_fields = array(); |
||
| 98 | |||
| 99 | /** |
||
| 100 | * Array of key => value data for saving. Likely $_POST data. |
||
| 101 | * @var array |
||
| 102 | * @since 2.0.0 |
||
| 103 | */ |
||
| 104 | public $data_to_save = array(); |
||
| 105 | |||
| 106 | /** |
||
| 107 | * Array of key => value data for saving. Likely $_POST data. |
||
| 108 | * @var string |
||
| 109 | * @since 2.0.0 |
||
| 110 | */ |
||
| 111 | protected $generated_nonce = ''; |
||
| 112 | |||
| 113 | /** |
||
| 114 | * Get started |
||
| 115 | * @since 0.4.0 |
||
| 116 | * @param array $meta_box Metabox config array |
||
| 117 | * @param integer $object_id Optional object id |
||
| 118 | */ |
||
| 119 | 42 | public function __construct( $meta_box, $object_id = 0 ) { |
|
| 120 | |||
| 121 | 42 | if ( empty( $meta_box['id'] ) ) { |
|
| 122 | 1 | wp_die( __( 'Metabox configuration is required to have an ID parameter', 'cmb2' ) ); |
|
| 123 | } |
||
| 124 | |||
| 125 | 42 | $this->meta_box = wp_parse_args( $meta_box, $this->mb_defaults ); |
|
| 126 | 42 | $this->meta_box['fields'] = array(); |
|
| 127 | |||
| 128 | 42 | $this->object_id( $object_id ); |
|
| 129 | 42 | $this->mb_object_type(); |
|
| 130 | 42 | $this->cmb_id = $meta_box['id']; |
|
| 131 | |||
| 132 | 42 | if ( ! empty( $meta_box['fields'] ) && is_array( $meta_box['fields'] ) ) { |
|
| 133 | 40 | $this->add_fields( $meta_box['fields'] ); |
|
| 134 | 40 | } |
|
| 135 | |||
| 136 | 42 | CMB2_Boxes::add( $this ); |
|
| 137 | |||
| 138 | /** |
||
| 139 | * Hook during initiation of CMB2 object |
||
| 140 | * |
||
| 141 | * The dynamic portion of the hook name, $this->cmb_id, is this meta_box id. |
||
| 142 | * |
||
| 143 | * @param array $cmb This CMB2 object |
||
| 144 | */ |
||
| 145 | 42 | do_action( "cmb2_init_{$this->cmb_id}", $this ); |
|
| 146 | 42 | } |
|
| 147 | |||
| 148 | /** |
||
| 149 | * Loops through and displays fields |
||
| 150 | * @since 1.0.0 |
||
| 151 | * @param int $object_id Object ID |
||
| 152 | * @param string $object_type Type of object being saved. (e.g., post, user, or comment) |
||
| 153 | */ |
||
| 154 | 1 | public function show_form( $object_id = 0, $object_type = '' ) { |
|
| 155 | 1 | $this->render_form_open( $object_id, $object_type ); |
|
| 156 | |||
| 157 | 1 | foreach ( $this->prop( 'fields' ) as $field_args ) { |
|
| 158 | 1 | $this->render_field( $field_args ); |
|
| 159 | 1 | } |
|
| 160 | |||
| 161 | 1 | $this->render_form_close( $object_id, $object_type ); |
|
| 162 | 1 | } |
|
| 163 | |||
| 164 | /** |
||
| 165 | * Outputs the opening form markup and runs corresponding hooks: |
||
| 166 | * 'cmb2_before_form' and "cmb2_before_{$object_type}_form_{$this->cmb_id}" |
||
| 167 | * @since 2.2.0 |
||
| 168 | * @param integer $object_id Object ID |
||
| 169 | * @param string $object_type Object type |
||
| 170 | * @return void |
||
| 171 | */ |
||
| 172 | 1 | View Code Duplication | public function render_form_open( $object_id = 0, $object_type = '' ) { |
| 173 | 1 | $object_type = $this->object_type( $object_type ); |
|
| 174 | 1 | $object_id = $this->object_id( $object_id ); |
|
| 175 | |||
| 176 | 1 | $this->nonce_field(); |
|
| 177 | |||
| 178 | 1 | echo "\n<!-- Begin CMB2 Fields -->\n"; |
|
| 179 | |||
| 180 | /** |
||
| 181 | * Hook before form table begins |
||
| 182 | * |
||
| 183 | * @param array $cmb_id The current box ID |
||
| 184 | * @param int $object_id The ID of the current object |
||
| 185 | * @param string $object_type The type of object you are working with. |
||
| 186 | * Usually `post` (this applies to all post-types). |
||
| 187 | * Could also be `comment`, `user` or `options-page`. |
||
| 188 | * @param array $cmb This CMB2 object |
||
| 189 | */ |
||
| 190 | 1 | do_action( 'cmb2_before_form', $this->cmb_id, $object_id, $object_type, $this ); |
|
| 191 | |||
| 192 | /** |
||
| 193 | * Hook before form table begins |
||
| 194 | * |
||
| 195 | * The first dynamic portion of the hook name, $object_type, is the type of object |
||
| 196 | * you are working with. Usually `post` (this applies to all post-types). |
||
| 197 | * Could also be `comment`, `user` or `options-page`. |
||
| 198 | * |
||
| 199 | * The second dynamic portion of the hook name, $this->cmb_id, is the meta_box id. |
||
| 200 | * |
||
| 201 | * @param array $cmb_id The current box ID |
||
| 202 | * @param int $object_id The ID of the current object |
||
| 203 | * @param array $cmb This CMB2 object |
||
| 204 | */ |
||
| 205 | 1 | do_action( "cmb2_before_{$object_type}_form_{$this->cmb_id}", $object_id, $this ); |
|
| 206 | |||
| 207 | 1 | echo '<div class="cmb2-wrap form-table"><div id="cmb2-metabox-', sanitize_html_class( $this->cmb_id ), '" class="cmb2-metabox cmb-field-list">'; |
|
| 208 | |||
| 209 | 1 | } |
|
| 210 | |||
| 211 | /** |
||
| 212 | * Outputs the closing form markup and runs corresponding hooks: |
||
| 213 | * 'cmb2_after_form' and "cmb2_after_{$object_type}_form_{$this->cmb_id}" |
||
| 214 | * @since 2.2.0 |
||
| 215 | * @param integer $object_id Object ID |
||
| 216 | * @param string $object_type Object type |
||
| 217 | * @return void |
||
| 218 | */ |
||
| 219 | 1 | View Code Duplication | public function render_form_close( $object_id = 0, $object_type = '' ) { |
| 220 | 1 | $object_type = $this->object_type( $object_type ); |
|
| 221 | 1 | $object_id = $this->object_id( $object_id ); |
|
| 222 | |||
| 223 | 1 | echo '</div></div>'; |
|
| 224 | |||
| 225 | 1 | $this->render_hidden_fields(); |
|
| 226 | |||
| 227 | /** |
||
| 228 | * Hook after form form has been rendered |
||
| 229 | * |
||
| 230 | * @param array $cmb_id The current box ID |
||
| 231 | * @param int $object_id The ID of the current object |
||
| 232 | * @param string $object_type The type of object you are working with. |
||
| 233 | * Usually `post` (this applies to all post-types). |
||
| 234 | * Could also be `comment`, `user` or `options-page`. |
||
| 235 | * @param array $cmb This CMB2 object |
||
| 236 | */ |
||
| 237 | 1 | do_action( 'cmb2_after_form', $this->cmb_id, $object_id, $object_type, $this ); |
|
| 238 | |||
| 239 | /** |
||
| 240 | * Hook after form form has been rendered |
||
| 241 | * |
||
| 242 | * The dynamic portion of the hook name, $this->cmb_id, is the meta_box id. |
||
| 243 | * |
||
| 244 | * The first dynamic portion of the hook name, $object_type, is the type of object |
||
| 245 | * you are working with. Usually `post` (this applies to all post-types). |
||
| 246 | * Could also be `comment`, `user` or `options-page`. |
||
| 247 | * |
||
| 248 | * @param int $object_id The ID of the current object |
||
| 249 | * @param array $cmb This CMB2 object |
||
| 250 | */ |
||
| 251 | 1 | do_action( "cmb2_after_{$object_type}_form_{$this->cmb_id}", $object_id, $this ); |
|
| 252 | |||
| 253 | 1 | echo "\n<!-- End CMB2 Fields -->\n"; |
|
| 254 | |||
| 255 | 1 | } |
|
| 256 | |||
| 257 | /** |
||
| 258 | * Renders a field based on the field type |
||
| 259 | * @since 2.2.0 |
||
| 260 | * @param array $field_args A field configuration array. |
||
| 261 | * @return mixed CMB2_Field object if successful. |
||
| 262 | */ |
||
| 263 | 1 | public function render_field( $field_args ) { |
|
| 264 | 1 | $field_args['context'] = $this->prop( 'context' ); |
|
| 265 | |||
| 266 | 1 | if ( 'group' == $field_args['type'] ) { |
|
| 267 | |||
| 268 | if ( ! isset( $field_args['show_names'] ) ) { |
||
| 269 | $field_args['show_names'] = $this->prop( 'show_names' ); |
||
| 270 | } |
||
| 271 | $field = $this->render_group( $field_args ); |
||
| 272 | |||
| 273 | 1 | } elseif ( 'hidden' == $field_args['type'] && $this->get_field( $field_args )->should_show() ) { |
|
| 274 | // Save rendering for after the metabox |
||
| 275 | $field = $this->add_hidden_field( array( |
||
| 276 | 'field_args' => $field_args, |
||
| 277 | 'object_type' => $this->object_type(), |
||
| 278 | 'object_id' => $this->object_id(), |
||
| 279 | ) ); |
||
| 280 | |||
| 281 | } else { |
||
| 282 | |||
| 283 | 1 | $field_args['show_names'] = $this->prop( 'show_names' ); |
|
| 284 | |||
| 285 | // Render default fields |
||
| 286 | 1 | $field = $this->get_field( $field_args )->render_field(); |
|
| 287 | } |
||
| 288 | |||
| 289 | 1 | return $field; |
|
| 290 | } |
||
| 291 | |||
| 292 | /** |
||
| 293 | * Render a repeatable group. |
||
| 294 | * @param array $args Array of field arguments for a group field parent. |
||
| 295 | * @return CMB2_Field|null Group field object. |
||
| 296 | */ |
||
| 297 | 2 | public function render_group( $args ) { |
|
| 298 | |||
| 299 | 2 | View Code Duplication | if ( ! isset( $args['id'], $args['fields'] ) || ! is_array( $args['fields'] ) ) { |
| 300 | return; |
||
| 301 | } |
||
| 302 | |||
| 303 | 2 | $field_group = $this->get_field( $args ); |
|
| 304 | |||
| 305 | // If field is requesting to be conditionally shown |
||
| 306 | 2 | if ( ! $field_group || ! $field_group->should_show() ) { |
|
| 307 | return; |
||
| 308 | } |
||
| 309 | |||
| 310 | 2 | $desc = $field_group->args( 'description' ); |
|
| 311 | 2 | $label = $field_group->args( 'name' ); |
|
| 312 | 2 | $sortable = $field_group->options( 'sortable' ) ? ' sortable' : ' non-sortable'; |
|
| 313 | 2 | $repeat_class = $field_group->args( 'repeatable' ) ? ' repeatable' : ' non-repeatable'; |
|
| 314 | 2 | $group_val = (array) $field_group->value(); |
|
| 315 | 2 | $nrows = count( $group_val ); |
|
| 316 | 2 | $remove_disabled = $nrows <= 1 ? 'disabled="disabled" ' : ''; |
|
| 317 | 2 | $field_group->index = 0; |
|
| 318 | |||
| 319 | 2 | $field_group->peform_param_callback( 'before_group' ); |
|
| 320 | |||
| 321 | 2 | echo '<div class="cmb-row cmb-repeat-group-wrap"><div class="cmb-td"><div id="', $field_group->id(), '_repeat" class="cmb-nested cmb-field-list cmb-repeatable-group', $sortable, $repeat_class, '" style="width:100%;">'; |
|
| 322 | |||
| 323 | 2 | if ( $desc || $label ) { |
|
| 324 | 2 | $class = $desc ? ' cmb-group-description' : ''; |
|
| 325 | 2 | echo '<div class="cmb-row', $class, '"><div class="cmb-th">'; |
|
| 326 | 2 | if ( $label ) { |
|
| 327 | 2 | echo '<h2 class="cmb-group-name">', $label, '</h2>'; |
|
| 328 | 2 | } |
|
| 329 | 2 | if ( $desc ) { |
|
| 330 | 1 | echo '<p class="cmb2-metabox-description">', $desc, '</p>'; |
|
| 331 | 1 | } |
|
| 332 | 2 | echo '</div></div>'; |
|
| 333 | 2 | } |
|
| 334 | |||
| 335 | 2 | if ( ! empty( $group_val ) ) { |
|
| 336 | |||
| 337 | foreach ( $group_val as $group_key => $field_id ) { |
||
| 338 | $this->render_group_row( $field_group, $remove_disabled ); |
||
| 339 | $field_group->index++; |
||
| 340 | } |
||
| 341 | } else { |
||
| 342 | 2 | $this->render_group_row( $field_group, $remove_disabled ); |
|
| 343 | } |
||
| 344 | |||
| 345 | 2 | if ( $field_group->args( 'repeatable' ) ) { |
|
| 346 | 1 | echo '<div class="cmb-row"><div class="cmb-td"><p class="cmb-add-row"><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>'; |
|
| 347 | 1 | } |
|
| 348 | |||
| 349 | 2 | echo '</div></div></div>'; |
|
| 350 | |||
| 351 | 2 | $field_group->peform_param_callback( 'after_group' ); |
|
| 352 | |||
| 353 | 2 | return $field_group; |
|
| 354 | } |
||
| 355 | |||
| 356 | /** |
||
| 357 | * Render a repeatable group row |
||
| 358 | * @since 1.0.2 |
||
| 359 | * @param CMB2_Field $field_group CMB2_Field group field object |
||
| 360 | * @param string $remove_disabled Attribute string to disable the remove button |
||
| 361 | */ |
||
| 362 | 2 | public function render_group_row( $field_group, $remove_disabled ) { |
|
| 363 | |||
| 364 | 2 | $field_group->peform_param_callback( 'before_group_row' ); |
|
| 365 | 2 | $closed_class = $field_group->options( 'closed' ) ? ' closed' : ''; |
|
| 366 | |||
| 367 | echo ' |
||
| 368 | 2 | <div class="postbox cmb-row cmb-repeatable-grouping', $closed_class, '" data-iterator="', $field_group->index, '">'; |
|
| 369 | |||
| 370 | 2 | if ( $field_group->args( 'repeatable' ) ) { |
|
| 371 | 1 | echo '<button ', $remove_disabled, 'data-selector="', $field_group->id(), '_repeat" class="dashicons-before dashicons-no-alt cmb-remove-group-row"></button>'; |
|
| 372 | 1 | } |
|
| 373 | |||
| 374 | echo ' |
||
| 375 | 2 | <div class="cmbhandle" title="' , __( 'Click to toggle', 'cmb2' ), '"><br></div> |
|
| 376 | 2 | <h3 class="cmb-group-title cmbhandle-title"><span>', $field_group->replace_hash( $field_group->options( 'group_title' ) ), '</span></h3> |
|
| 377 | |||
| 378 | <div class="inside cmb-td cmb-nested cmb-field-list">'; |
||
| 379 | // Loop and render repeatable group fields |
||
| 380 | 2 | foreach ( array_values( $field_group->args( 'fields' ) ) as $field_args ) { |
|
| 381 | 2 | if ( 'hidden' == $field_args['type'] ) { |
|
| 382 | |||
| 383 | // Save rendering for after the metabox |
||
| 384 | $this->add_hidden_field( array( |
||
| 385 | 'field_args' => $field_args, |
||
| 386 | 'group_field' => $field_group, |
||
| 387 | ) ); |
||
| 388 | |||
| 389 | } else { |
||
| 390 | |||
| 391 | 2 | $field_args['show_names'] = $field_group->args( 'show_names' ); |
|
| 392 | 2 | $field_args['context'] = $field_group->args( 'context' ); |
|
| 393 | |||
| 394 | 2 | $field = $this->get_field( $field_args, $field_group )->render_field(); |
|
| 395 | } |
||
| 396 | 2 | } |
|
| 397 | 2 | if ( $field_group->args( 'repeatable' ) ) { |
|
| 398 | echo ' |
||
| 399 | <div class="cmb-row cmb-remove-field-row"> |
||
| 400 | <div class="cmb-remove-row"> |
||
| 401 | 1 | <button ', $remove_disabled, 'data-selector="', $field_group->id(), '_repeat" class="button cmb-remove-group-row alignright">', $field_group->options( 'remove_button' ), '</button> |
|
| 402 | </div> |
||
| 403 | </div> |
||
| 404 | '; |
||
| 405 | 1 | } |
|
| 406 | echo ' |
||
| 407 | </div> |
||
| 408 | </div> |
||
| 409 | 2 | '; |
|
| 410 | |||
| 411 | 2 | $field_group->peform_param_callback( 'after_group_row' ); |
|
| 412 | 2 | } |
|
| 413 | |||
| 414 | /** |
||
| 415 | * Add a hidden field to the list of hidden fields to be rendered later |
||
| 416 | * @since 2.0.0 |
||
| 417 | * @param array $args Array of arguments to be passed to CMB2_Field |
||
| 418 | */ |
||
| 419 | public function add_hidden_field( $args ) { |
||
| 420 | $field = new CMB2_Field( $args ); |
||
| 421 | $this->hidden_fields[] = new CMB2_Types( $field ); |
||
| 422 | |||
| 423 | return $field; |
||
| 424 | } |
||
| 425 | |||
| 426 | /** |
||
| 427 | * Loop through and output hidden fields |
||
| 428 | * @since 2.0.0 |
||
| 429 | */ |
||
| 430 | 1 | public function render_hidden_fields() { |
|
| 431 | 1 | if ( ! empty( $this->hidden_fields ) ) { |
|
| 432 | foreach ( $this->hidden_fields as $hidden ) { |
||
| 433 | $hidden->render(); |
||
| 434 | } |
||
| 435 | } |
||
| 436 | 1 | } |
|
| 437 | |||
| 438 | /** |
||
| 439 | * Returns array of sanitized field values (without saving them) |
||
| 440 | * @since 2.0.3 |
||
| 441 | * @param array $data_to_sanitize Array of field_id => value data for sanitizing (likely $_POST data). |
||
| 442 | */ |
||
| 443 | 2 | public function get_sanitized_values( array $data_to_sanitize ) { |
|
| 444 | 2 | $this->data_to_save = $data_to_sanitize; |
|
| 445 | 2 | $stored_id = $this->object_id(); |
|
| 446 | |||
| 447 | // We do this So CMB will sanitize our data for us, but not save it |
||
| 448 | 2 | $this->object_id( '_' ); |
|
| 449 | |||
| 450 | // Ensure temp. data store is empty |
||
| 451 | 2 | cmb2_options( 0 )->set(); |
|
| 452 | |||
| 453 | // Process/save fields |
||
| 454 | 2 | $this->process_fields(); |
|
| 455 | |||
| 456 | // Get data from temp. data store |
||
| 457 | 2 | $sanitized_values = cmb2_options( 0 )->get_options(); |
|
| 458 | |||
| 459 | // Empty out temp. data store again |
||
| 460 | 2 | cmb2_options( 0 )->set(); |
|
| 461 | |||
| 462 | // Reset the object id |
||
| 463 | 2 | $this->object_id( $stored_id ); |
|
| 464 | |||
| 465 | 2 | return $sanitized_values; |
|
| 466 | } |
||
| 467 | |||
| 468 | /** |
||
| 469 | * Loops through and saves field data |
||
| 470 | * @since 1.0.0 |
||
| 471 | * @param int $object_id Object ID |
||
| 472 | * @param string $object_type Type of object being saved. (e.g., post, user, or comment) |
||
| 473 | * @param array $data_to_save Array of key => value data for saving. Likely $_POST data. |
||
| 474 | */ |
||
| 475 | public function save_fields( $object_id = 0, $object_type = '', $data_to_save = array() ) { |
||
| 476 | |||
| 477 | // Fall-back to $_POST data |
||
| 478 | $this->data_to_save = ! empty( $data_to_save ) ? $data_to_save : $_POST; |
||
| 479 | $object_id = $this->object_id( $object_id ); |
||
| 480 | $object_type = $this->object_type( $object_type ); |
||
| 481 | |||
| 482 | $this->process_fields(); |
||
| 483 | |||
| 484 | // If options page, save the updated options |
||
| 485 | if ( 'options-page' == $object_type ) { |
||
| 486 | cmb2_options( $object_id )->set(); |
||
| 487 | } |
||
| 488 | |||
| 489 | /** |
||
| 490 | * Fires after all fields have been saved. |
||
| 491 | * |
||
| 492 | * The dynamic portion of the hook name, $object_type, refers to the metabox/form's object type |
||
| 493 | * Usually `post` (this applies to all post-types). |
||
| 494 | * Could also be `comment`, `user` or `options-page`. |
||
| 495 | * |
||
| 496 | * @param int $object_id The ID of the current object |
||
| 497 | * @param array $cmb_id The current box ID |
||
| 498 | * @param string $updated Array of field ids that were updated. |
||
| 499 | * Will only include field ids that had values change. |
||
| 500 | * @param array $cmb This CMB2 object |
||
| 501 | */ |
||
| 502 | do_action( "cmb2_save_{$object_type}_fields", $object_id, $this->cmb_id, $this->updated, $this ); |
||
| 503 | |||
| 504 | /** |
||
| 505 | * Fires after all fields have been saved. |
||
| 506 | * |
||
| 507 | * The dynamic portion of the hook name, $this->cmb_id, is the meta_box id. |
||
| 508 | * |
||
| 509 | * The dynamic portion of the hook name, $object_type, refers to the metabox/form's object type |
||
| 510 | * Usually `post` (this applies to all post-types). |
||
| 511 | * Could also be `comment`, `user` or `options-page`. |
||
| 512 | * |
||
| 513 | * @param int $object_id The ID of the current object |
||
| 514 | * @param string $updated Array of field ids that were updated. |
||
| 515 | * Will only include field ids that had values change. |
||
| 516 | * @param array $cmb This CMB2 object |
||
| 517 | */ |
||
| 518 | do_action( "cmb2_save_{$object_type}_fields_{$this->cmb_id}", $object_id, $this->updated, $this ); |
||
| 519 | |||
| 520 | } |
||
| 521 | |||
| 522 | /** |
||
| 523 | * Process and save form fields |
||
| 524 | * @since 2.0.0 |
||
| 525 | */ |
||
| 526 | 2 | public function process_fields() { |
|
| 527 | |||
| 528 | /** |
||
| 529 | * Fires before fields have been processed/saved. |
||
| 530 | * |
||
| 531 | * The dynamic portion of the hook name, $this->cmb_id, is the meta_box id. |
||
| 532 | * |
||
| 533 | * The dynamic portion of the hook name, $object_type, refers to the metabox/form's object type |
||
| 534 | * Usually `post` (this applies to all post-types). |
||
| 535 | * Could also be `comment`, `user` or `options-page`. |
||
| 536 | * |
||
| 537 | * @param array $cmb This CMB2 object |
||
| 538 | * @param int $object_id The ID of the current object |
||
| 539 | */ |
||
| 540 | 2 | do_action( "cmb2_{$this->object_type()}_process_fields_{$this->cmb_id}", $this, $this->object_id() ); |
|
| 541 | |||
| 542 | // Remove the show_on properties so saving works |
||
| 543 | 2 | $this->prop( 'show_on', array() ); |
|
| 544 | |||
| 545 | // save field ids of those that are updated |
||
| 546 | 2 | $this->updated = array(); |
|
| 547 | |||
| 548 | 2 | foreach ( $this->prop( 'fields' ) as $field_args ) { |
|
| 549 | 2 | $this->process_field( $field_args ); |
|
| 550 | 2 | } |
|
| 551 | 2 | } |
|
| 552 | |||
| 553 | /** |
||
| 554 | * Process and save a field |
||
| 555 | * @since 2.0.0 |
||
| 556 | * @param array $field_args Array of field arguments |
||
| 557 | */ |
||
| 558 | 2 | public function process_field( $field_args ) { |
|
| 559 | |||
| 560 | 2 | switch ( $field_args['type'] ) { |
|
| 561 | |||
| 562 | 2 | case 'group': |
|
| 563 | 1 | $this->save_group( $field_args ); |
|
| 564 | 1 | break; |
|
| 565 | |||
| 566 | 1 | case 'title': |
|
| 567 | // Don't process title fields |
||
| 568 | break; |
||
| 569 | |||
| 570 | 1 | default: |
|
| 571 | |||
| 572 | // Save default fields |
||
| 573 | 1 | $field = new CMB2_Field( array( |
|
| 574 | 1 | 'field_args' => $field_args, |
|
| 575 | 1 | 'object_type' => $this->object_type(), |
|
| 576 | 1 | 'object_id' => $this->object_id(), |
|
| 577 | 1 | ) ); |
|
| 578 | |||
| 579 | 1 | if ( $field->save_field_from_data( $this->data_to_save ) ) { |
|
| 580 | 1 | $this->updated[] = $field->id(); |
|
| 581 | 1 | } |
|
| 582 | |||
| 583 | 1 | break; |
|
| 584 | 2 | } |
|
| 585 | |||
| 586 | 2 | } |
|
| 587 | |||
| 588 | /** |
||
| 589 | * Save a repeatable group |
||
| 590 | */ |
||
| 591 | 1 | public function save_group( $args ) { |
|
| 592 | |||
| 593 | 1 | View Code Duplication | if ( ! isset( $args['id'], $args['fields'], $this->data_to_save[ $args['id'] ] ) || ! is_array( $args['fields'] ) ) { |
| 594 | return; |
||
| 595 | } |
||
| 596 | |||
| 597 | 1 | $field_group = new CMB2_Field( array( |
|
| 598 | 1 | 'field_args' => $args, |
|
| 599 | 1 | 'object_type' => $this->object_type(), |
|
| 600 | 1 | 'object_id' => $this->object_id(), |
|
| 601 | 1 | ) ); |
|
| 602 | 1 | $base_id = $field_group->id(); |
|
| 603 | 1 | $old = $field_group->get_data(); |
|
| 604 | // Check if group field has sanitization_cb |
||
| 605 | 1 | $group_vals = $field_group->sanitization_cb( $this->data_to_save[ $base_id ] ); |
|
| 606 | 1 | $saved = array(); |
|
| 607 | 1 | $field_group->index = 0; |
|
| 608 | 1 | $field_group->data_to_save = $this->data_to_save; |
|
| 609 | |||
| 610 | 1 | foreach ( array_values( $field_group->fields() ) as $field_args ) { |
|
| 611 | 1 | $field = new CMB2_Field( array( |
|
| 612 | 1 | 'field_args' => $field_args, |
|
| 613 | 1 | 'group_field' => $field_group, |
|
| 614 | 1 | ) ); |
|
| 615 | 1 | $sub_id = $field->id( true ); |
|
| 616 | |||
| 617 | 1 | foreach ( (array) $group_vals as $field_group->index => $post_vals ) { |
|
| 618 | |||
| 619 | // Get value |
||
| 620 | 1 | $new_val = isset( $group_vals[ $field_group->index ][ $sub_id ] ) |
|
| 621 | 1 | ? $group_vals[ $field_group->index ][ $sub_id ] |
|
| 622 | 1 | : false; |
|
| 623 | |||
| 624 | // Sanitize |
||
| 625 | 1 | $new_val = $field->sanitization_cb( $new_val ); |
|
| 626 | |||
| 627 | 1 | if ( is_array( $new_val ) && $field->args( 'has_supporting_data' ) ) { |
|
| 628 | 1 | if ( $field->args( 'repeatable' ) ) { |
|
| 629 | 1 | $_new_val = array(); |
|
| 630 | 1 | foreach ( $new_val as $group_index => $grouped_data ) { |
|
| 631 | // Add the supporting data to the $saved array stack |
||
| 632 | 1 | $saved[ $field_group->index ][ $grouped_data['supporting_field_id'] ][] = $grouped_data['supporting_field_value']; |
|
| 633 | // Reset var to the actual value |
||
| 634 | 1 | $_new_val[ $group_index ] = $grouped_data['value']; |
|
| 635 | 1 | } |
|
| 636 | 1 | $new_val = $_new_val; |
|
| 637 | 1 | } else { |
|
| 638 | // Add the supporting data to the $saved array stack |
||
| 639 | 1 | $saved[ $field_group->index ][ $new_val['supporting_field_id'] ] = $new_val['supporting_field_value']; |
|
| 640 | // Reset var to the actual value |
||
| 641 | 1 | $new_val = $new_val['value']; |
|
| 642 | } |
||
| 643 | 1 | } |
|
| 644 | |||
| 645 | // Get old value |
||
| 646 | 1 | $old_val = is_array( $old ) && isset( $old[ $field_group->index ][ $sub_id ] ) |
|
| 647 | 1 | ? $old[ $field_group->index ][ $sub_id ] |
|
| 648 | 1 | : false; |
|
| 649 | |||
| 650 | 1 | $is_updated = ( ! empty( $new_val ) && $new_val != $old_val ); |
|
| 651 | 1 | $is_removed = ( empty( $new_val ) && ! empty( $old_val ) ); |
|
| 652 | // Compare values and add to `$updated` array |
||
| 653 | 1 | if ( $is_updated || $is_removed ) { |
|
| 654 | 1 | $this->updated[] = $base_id . '::' . $field_group->index . '::' . $sub_id; |
|
| 655 | 1 | } |
|
| 656 | |||
| 657 | // Add to `$saved` array |
||
| 658 | 1 | $saved[ $field_group->index ][ $sub_id ] = $new_val; |
|
| 659 | |||
| 660 | 1 | } |
|
| 661 | 1 | $saved[ $field_group->index ] = array_filter( $saved[ $field_group->index ] ); |
|
| 662 | 1 | } |
|
| 663 | 1 | $saved = array_filter( $saved ); |
|
| 664 | |||
| 665 | 1 | $field_group->update_data( $saved, true ); |
|
| 666 | 1 | } |
|
| 667 | |||
| 668 | /** |
||
| 669 | * Get object id from global space if no id is provided |
||
| 670 | * @since 1.0.0 |
||
| 671 | * @param integer $object_id Object ID |
||
| 672 | * @return integer $object_id Object ID |
||
| 673 | */ |
||
| 674 | 42 | public function object_id( $object_id = 0 ) { |
|
| 675 | 42 | global $pagenow; |
|
| 676 | |||
| 677 | 42 | if ( $object_id ) { |
|
| 678 | 13 | $this->object_id = $object_id; |
|
| 679 | 13 | return $this->object_id; |
|
| 680 | } |
||
| 681 | |||
| 682 | 42 | if ( $this->object_id ) { |
|
| 683 | 11 | return $this->object_id; |
|
| 684 | } |
||
| 685 | |||
| 686 | // Try to get our object ID from the global space |
||
| 687 | 41 | switch ( $this->object_type() ) { |
|
| 688 | 41 | case 'user': |
|
| 689 | $object_id = isset( $_REQUEST['user_id'] ) ? $_REQUEST['user_id'] : $object_id; |
||
| 690 | $object_id = ! $object_id && 'user-new.php' != $pagenow && isset( $GLOBALS['user_ID'] ) ? $GLOBALS['user_ID'] : $object_id; |
||
| 691 | break; |
||
| 692 | |||
| 693 | 41 | case 'comment': |
|
| 694 | $object_id = isset( $_REQUEST['c'] ) ? $_REQUEST['c'] : $object_id; |
||
| 695 | $object_id = ! $object_id && isset( $GLOBALS['comments']->comment_ID ) ? $GLOBALS['comments']->comment_ID : $object_id; |
||
| 696 | break; |
||
| 697 | |||
| 698 | 41 | case 'term': |
|
| 699 | $object_id = isset( $_REQUEST['tag_ID'] ) ? $_REQUEST['tag_ID'] : $object_id; |
||
| 700 | break; |
||
| 701 | |||
| 702 | 41 | default: |
|
| 703 | 41 | $object_id = isset( $GLOBALS['post']->ID ) ? $GLOBALS['post']->ID : $object_id; |
|
| 704 | 41 | $object_id = isset( $_REQUEST['post'] ) ? $_REQUEST['post'] : $object_id; |
|
| 705 | 41 | break; |
|
| 706 | 41 | } |
|
| 707 | |||
| 708 | // reset to id or 0 |
||
| 709 | 41 | $this->object_id = $object_id ? $object_id : 0; |
|
| 710 | |||
| 711 | 41 | return $this->object_id; |
|
| 712 | } |
||
| 713 | |||
| 714 | /** |
||
| 715 | * Sets the $object_type based on metabox settings |
||
| 716 | * @since 1.0.0 |
||
| 717 | * @return string Object type |
||
| 718 | */ |
||
| 719 | 42 | public function mb_object_type() { |
|
| 720 | |||
| 721 | 42 | if ( null !== $this->mb_object_type ) { |
|
| 722 | 12 | return $this->mb_object_type; |
|
| 723 | } |
||
| 724 | |||
| 725 | 42 | if ( $this->is_options_page_mb() ) { |
|
| 726 | 35 | $this->mb_object_type = 'options-page'; |
|
| 727 | 35 | return $this->mb_object_type; |
|
| 728 | } |
||
| 729 | |||
| 730 | 42 | if ( ! $this->prop( 'object_types' ) ) { |
|
| 731 | 40 | $this->mb_object_type = 'post'; |
|
| 732 | 40 | return $this->mb_object_type; |
|
| 733 | } |
||
| 734 | |||
| 735 | 3 | $type = false; |
|
| 736 | // check if 'object_types' is a string |
||
| 737 | 3 | if ( is_string( $this->prop( 'object_types' ) ) ) { |
|
| 738 | $type = $this->prop( 'object_types' ); |
||
| 739 | } |
||
| 740 | // if it's an array of one, extract it |
||
| 741 | 3 | elseif ( is_array( $this->prop( 'object_types' ) ) && 1 === count( $this->prop( 'object_types' ) ) ) { |
|
| 742 | 3 | $cpts = $this->prop( 'object_types' ); |
|
| 743 | 3 | $type = is_string( end( $cpts ) ) |
|
| 744 | 3 | ? end( $cpts ) |
|
| 745 | 3 | : false; |
|
| 746 | 3 | } |
|
| 747 | |||
| 748 | 3 | if ( ! $type ) { |
|
| 749 | $this->mb_object_type = 'post'; |
||
| 750 | return $this->mb_object_type; |
||
| 751 | } |
||
| 752 | |||
| 753 | // Get our object type |
||
| 754 | switch ( $type ) { |
||
| 755 | |||
| 756 | 3 | case 'user': |
|
| 757 | 3 | case 'comment': |
|
| 758 | 3 | case 'term': |
|
| 759 | 1 | $this->mb_object_type = $type; |
|
| 760 | 1 | break; |
|
| 761 | |||
| 762 | 2 | default: |
|
| 763 | 2 | $this->mb_object_type = 'post'; |
|
| 764 | 2 | break; |
|
| 765 | 2 | } |
|
| 766 | |||
| 767 | 3 | return $this->mb_object_type; |
|
| 768 | } |
||
| 769 | |||
| 770 | /** |
||
| 771 | * Determines if metabox is for an options page |
||
| 772 | * @since 1.0.1 |
||
| 773 | * @return boolean True/False |
||
| 774 | */ |
||
| 775 | 42 | public function is_options_page_mb() { |
|
| 778 | |||
| 779 | /** |
||
| 780 | * Returns the object type |
||
| 781 | * @since 1.0.0 |
||
| 782 | * @return string Object type |
||
| 783 | */ |
||
| 784 | 42 | public function object_type( $object_type = '' ) { |
|
| 785 | 42 | if ( $object_type ) { |
|
| 786 | 12 | $this->object_type = $object_type; |
|
| 787 | 12 | return $this->object_type; |
|
| 788 | } |
||
| 789 | |||
| 790 | 42 | if ( $this->object_type ) { |
|
| 791 | 42 | return $this->object_type; |
|
| 792 | } |
||
| 793 | |||
| 794 | global $pagenow; |
||
| 811 | |||
| 812 | /** |
||
| 813 | * Get metabox property and optionally set a fallback |
||
| 814 | * @since 2.0.0 |
||
| 815 | * @param string $property Metabox config property to retrieve |
||
| 816 | * @param mixed $fallback Fallback value to set if no value found |
||
| 817 | * @return mixed Metabox config property value or false |
||
| 818 | */ |
||
| 819 | 42 | public function prop( $property, $fallback = null ) { |
|
| 826 | |||
| 827 | /** |
||
| 828 | * Get a field object |
||
| 829 | * |
||
| 830 | * @since 2.0.3 |
||
| 831 | * |
||
| 832 | * @param string|array|CMB2_Field $field Metabox field id or field config array or CMB2_Field object |
||
| 833 | * @param CMB2_Field $field_group (optional) CMB2_Field object (group parent) |
||
| 834 | * |
||
| 835 | * @return CMB2_Field|false CMB2_Field object (or false) |
||
| 836 | */ |
||
| 837 | 15 | public function get_field( $field, $field_group = null ) { |
|
| 862 | |||
| 863 | /** |
||
| 864 | * Handles determining which type of arguments to pass to CMB2_Field |
||
| 865 | * @since 2.0.7 |
||
| 866 | * @param mixed $field_id Field (or group field) ID |
||
| 867 | * @param mixed $field_args Array of field arguments |
||
| 868 | * @param mixed $sub_field_id Sub field ID (if field_group exists) |
||
| 869 | * @param mixed $field_group If a sub-field, will be the parent group CMB2_Field object |
||
| 870 | * @return array Array of CMB2_Field arguments |
||
| 871 | */ |
||
| 872 | 13 | public function get_field_args( $field_id, $field_args, $sub_field_id, $field_group ) { |
|
| 897 | |||
| 898 | /** |
||
| 899 | * When fields are added in the old-school way, intitate them as they should be |
||
| 900 | * @since 2.1.0 |
||
| 901 | * @param array $fields Array of fields to add |
||
| 902 | * @param mixed $parent_field_id Parent field id or null |
||
| 903 | */ |
||
| 904 | 40 | protected function add_fields( $fields, $parent_field_id = null ) { |
|
| 922 | |||
| 923 | /** |
||
| 924 | * Add a field to the metabox |
||
| 925 | * @since 2.0.0 |
||
| 926 | * @param array $field Metabox field config array |
||
| 927 | * @param int $position (optional) Position of metabox. 1 for first, etc |
||
| 928 | * @return mixed Field id or false |
||
| 929 | */ |
||
| 930 | 42 | public function add_field( array $field, $position = 0 ) { |
|
| 943 | |||
| 944 | /** |
||
| 945 | * Add a field to a group |
||
| 946 | * @since 2.0.0 |
||
| 947 | * @param string $parent_field_id The field id of the group field to add the field |
||
| 948 | * @param array $field Metabox field config array |
||
| 949 | * @param int $position (optional) Position of metabox. 1 for first, etc |
||
| 950 | * @return mixed Array of parent/field ids or false |
||
| 951 | */ |
||
| 952 | 3 | public function add_group_field( $parent_field_id, array $field, $position = 0 ) { |
|
| 975 | |||
| 976 | /** |
||
| 977 | * Add a field array to a fields array in desired position |
||
| 978 | * @since 2.0.2 |
||
| 979 | * @param array $field Metabox field config array |
||
| 980 | * @param array &$fields Array (passed by reference) to append the field (array) to |
||
| 981 | * @param integer $position Optionally specify a position in the array to be inserted |
||
| 982 | */ |
||
| 983 | 42 | protected function _add_field_to_array( $field, &$fields, $position = 0 ) { |
|
| 990 | |||
| 991 | /** |
||
| 992 | * Remove a field from the metabox |
||
| 993 | * @since 2.0.0 |
||
| 994 | * @param string $field_id The field id of the field to remove |
||
| 995 | * @param string $parent_field_id (optional) The field id of the group field to remove field from |
||
| 996 | * @return bool True if field was removed |
||
| 997 | */ |
||
| 998 | 2 | public function remove_field( $field_id, $parent_field_id = '' ) { |
|
| 1022 | |||
| 1023 | /** |
||
| 1024 | * Update or add a property to a field |
||
| 1025 | * @since 2.0.0 |
||
| 1026 | * @param string $field_id Field id |
||
| 1027 | * @param string $property Field property to set/update |
||
| 1028 | * @param mixed $value Value to set the field property |
||
| 1029 | * @param string $parent_field_id (optional) The field id of the group field to remove field from |
||
| 1030 | * @return mixed Field id. Strict compare to false, as success can return a falsey value (like 0) |
||
| 1031 | */ |
||
| 1032 | 4 | public function update_field_property( $field_id, $property, $value, $parent_field_id = '' ) { |
|
| 1049 | |||
| 1050 | /** |
||
| 1051 | * Check if field ids match a field and return the index/field id |
||
| 1052 | * @since 2.0.2 |
||
| 1053 | * @param string $field_id Field id |
||
| 1054 | * @param string $parent_field_id (optional) Parent field id |
||
| 1055 | * @return mixed Array of field/parent ids, or false |
||
| 1056 | */ |
||
| 1057 | 19 | public function get_field_ids( $field_id, $parent_field_id = '' ) { |
|
| 1084 | |||
| 1085 | /** |
||
| 1086 | * When using the old array filter, it is unlikely field array indexes will be the field id |
||
| 1087 | * @since 2.0.2 |
||
| 1088 | * @param string $field_id The field id |
||
| 1089 | * @param array $fields Array of fields to search |
||
| 1090 | * @return mixed Field index or false |
||
| 1091 | */ |
||
| 1092 | 2 | public function search_old_school_array( $field_id, $fields ) { |
|
| 1097 | |||
| 1098 | /** |
||
| 1099 | * Determine whether this cmb object should show, based on the 'show_on_cb' callback. |
||
| 1100 | * |
||
| 1101 | * @since 2.0.9 |
||
| 1102 | * |
||
| 1103 | * @return bool Whether this cmb should be shown. |
||
| 1104 | */ |
||
| 1105 | View Code Duplication | public function should_show() { |
|
| 1116 | |||
| 1117 | /** |
||
| 1118 | * Generate a unique nonce field for each registered meta_box |
||
| 1119 | * @since 2.0.0 |
||
| 1120 | * @return string unique nonce hidden input |
||
| 1121 | */ |
||
| 1122 | 1 | public function nonce_field() { |
|
| 1125 | |||
| 1126 | /** |
||
| 1127 | * Generate a unique nonce for each registered meta_box |
||
| 1128 | * @since 2.0.0 |
||
| 1129 | * @return string unique nonce string |
||
| 1130 | */ |
||
| 1131 | 1 | public function nonce() { |
|
| 1138 | |||
| 1139 | /** |
||
| 1140 | * Magic getter for our object. |
||
| 1141 | * @param string $field |
||
| 1142 | * @throws Exception Throws an exception if the field is invalid. |
||
| 1143 | * @return mixed |
||
| 1144 | */ |
||
| 1145 | 42 | public function __get( $field ) { |
|
| 1157 | |||
| 1158 | } |
||
| 1159 |
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.