Custom field Types that are repeatable are not shown properly.

[bnecreative]

Prior to v2.2.4, a custom field that has more than one field would output normally in a repeatable set. The new custom field is built similarly to the address field that is in the CMB2 code library. It comprises of two fields - 1) text 2) textarea.

Expected Behavior:

Prior to v2.2.4, a custom field that has more than one field would output normally in a repeatable set.

Image: https://www.dropbox.com/s/2qqgssl9w1cwin0/people-before224.png?dl=0

Actual Behavior:

Since v2.2.4, only the second field of the set is added in a repeatable set after clicking the add row button. In addition, the surrounding html markup of the 2 fields are not included in the new row.

Image: https://www.dropbox.com/s/b3ofkh2sninevi2/people224.png?dl=0

Steps to reproduce (I have confirmed I can reproduce this issue on the trunk branch):

1. Add a normal cmb2 box with a custom field
2. Add needed functions to build out the field

CMB2 Field Registration Code:

add_action( 'cmb2_admin_init', 'yourprefix_register_demo_metabox' );
function yourprefix_register_demo_metabox() {

	$cmb = new_cmb2_box( array(
		'id'            =>	'bne_people_details',
		'title'         =>  __( 'Profile Details', 'bne' ),
		'object_types'  =>  array( 'post-type-name' ),
		'classes'		=>	'bne-cmb-wrapper'
	) );


	// Field - Extra Content
	$cmb->add_field( array(
		'name'    		=>	__( 'name', 'bne' ),
		'desc'    		=>	__( 'description', 'bne' ),
		'id'      		=>	'details',
		'type'    		=>	'bne_people_details_repeater',
		'repeatable'	=>	true,
		'text'			=>	array(
			'add_row_text'	=>	__( 'Add Detail', 'bne' )
		)
	) );
}

function bne_people_details_field( $field, $value, $object_id, $object_type, $field_type ) {

	// Make sure we specify each part of the value we need.
	$value = wp_parse_args( $value, array(
		'label'		=>	'',
		'content'	=>	'',
	) );

	// Label
	echo '<div class="col-4">';
		echo '<div class="bne-field-option clearfix">';
			echo '<label>'.__( 'Label', 'bne' ).'</label>';
			echo $field_type->input( array(
				'name'    		=>	$field_type->_name( '[label]' ),
				'id'      		=>	$field_type->_id( '_label' ),
				'value' 		=> 	$value['label'],
				'desc'    		=> 	'',
				'placeholder'	=>	'ex: Email',
			) );
		echo '</div>';
	echo '</div>';

	// Content
	echo '<div class="col-8">';
		echo '<div class="bne-field-option clearfix">';
			echo '<label>'.__( 'Content', 'bne' ).'</label>';
			echo $field_type->textarea( array(
				'name'    		=>	$field_type->_name( '[content]' ),
				'id'      		=>	$field_type->_id( '_content' ),
				'value' 		=> 	$value['content'],
				'desc'    		=> 	'',
				'rows'			=>	'1',
				'placeholder'	=>	'ex: mail@example.com',
			) );
		echo '</div>';
	echo '</div>';

	// Field Description
	echo $field_type->_desc( true );

}
add_filter( 'cmb2_render_bne_people_details_repeater', 'bne_people_details_field', 10, 5 );

/*
 * 	The following snippets are required for allowing the fields above
 * 	to work as a repeatable field, or in a repeatable group in CMB2.
 *
*/
function bne_people_cmb2_sanitize_field( $check, $meta_value, $object_id, $field_args, $sanitize_object ) {
	// if not repeatable, bail out.
	if ( ! is_array( $meta_value ) || ! $field_args['repeatable'] ) {
		return $check;
	}
	foreach ( $meta_value as $key => $val ) {
		$meta_value[ $key ] = array_filter( array_map( 'sanitize_text_field', $val ) );
	}
	return array_filter( $meta_value );
}
add_filter( 'cmb2_sanitize_bne_people_details_repeater', 'bne_people_cmb2_sanitize_field', 10, 5 );

function bne_people_cmb2_types_esc_field( $check, $meta_value, $field_args, $field_object ) {
	// if not repeatable, bail out.
	if ( ! is_array( $meta_value ) || ! $field_args['repeatable'] ) {
		return $check;
	}
	foreach ( $meta_value as $key => $val ) {
		if( $val )
		$meta_value[ $key ] = array_filter( array_map( 'esc_attr', $val ) );
	}
	return array_filter( $meta_value );
}
add_filter( 'cmb2_types_esc_bne_people_details_repeater', 'bne_people_cmb2_types_esc_field', 10, 4 );

[RubenMartins]

Any update on this?
I'm also experiencing this with 4 custom fields and only the 4th is added to a new line of repeatable field.

[tw2113]

No word that I've seen, but I also missed seeing this one.

@RubenMartins are you also do your own custom field type like the issue opener is?

[tw2113]

git bisect shows that this commit is what broke the code above in the original posting: 410cee4

[tw2113]

Based on further testing, the __call() method is hit twice, and houses this line 410cee4#diff-32fc356ab519c81b4a672288be3a1e46R61

For the first hit, $object returns null, and doesn't execute render. However the second one does, with the $object be of type CMB2_Type_Textarea

@jtsternberg Any light on this one? You're more aware of the change involved than I am.

[RubenMartins]

@tw2113 yes I created an custom field with cmb2_render_ function witch is repeatable. And prior to the version 2.2.4 this works fine but with this version this bug appeared.

[RubenMartins]

Any update on this @jtsternberg ?

[tw2113]

Nothing I've personally seen. @jtsternberg Re-pinging you for some possible feedback.

[desrosj]

I am also encountering this. A custom field added in the same manner described (cmb2_render_{$field_type}) is not properly adding a new row.

[desrosj]

@bnecreative I noticed in the code that you provided, you have three filters. I believe that your cmb2_render_bne_people_details_repeater hook should be an action, not a filter.

I have opened a pull request that fixes the issue as I saw it happening. Any testing is appreciated!

[tw2113]

PR mentioned: #969

[bnecreative]

@desrosj add_filter was used in the initial wiki example of making an address field which is why I used it; regardless, both works. This PR, changing the return to false, does works on my end using trunk. I'm not sure if there is a side effect to that change for other scenarios.

[desrosj]

@bnecreative Gotcha! Was worth double checking. I am somewhat new to CMB2, so some older code examples may not stand out as such to me.

Thanks for confirming that the PR fixes the issue for you. I am going to work on some unit tests for the pull request to prove it does what it's supposed to without any ill effects and hopefully we can get this fixed.

[sakutasanen]

I also encountered this bug. I would appreciate if this would be fixed soon.