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