CMB2 Taxonomy Select not saving in database

(@tw2113)

The BenchPresser

For the website admin to display certain downloads on specific pages I have created a ‘taxonomy_select’ drop down field using CMB2, this worked fine on the initial build but once the user changes the desired category no posts will then show.
In this case, the user is the admin/editor/etc changing the metabox value in the admin area for the specific page? Have you confirmed the updated category selection is reflecting in the WP_Query you’re making at the template level? Do you have caching going on perhaps that would slow down that display?

It seems that the selection of a new category does not create a new table within the database.
Shouldn’t be doing new tables in the first place ?? The dropdown should be based on available taxonomy terms, and the saved value for the metabox should be updating existing wp_postmeta rows for the corresponding keys, unless it’s a new post. Minor details here, I believe.

Thread Starter

(@tomarmstrong)

Hi, many thanks for getting back to me.

In this case, the user is the admin/editor/etc changing the metabox value in the admin area for the specific page? Yes it’s just a drop down on one of the pages edit view.

Have you confirmed the updated category selection is reflecting in the WP_Query you’re making at the template level?
I’ve looked at the value of download category and it is not returning anything/returning an empty value.

$download_category = get_post_meta(get_the_ID(), '_ct_download_cat', true);

I had a look a bit deeper and if you manually add a row to the table in wp_postmeta it works perfectly, but once it’s changed (drop down in page edit view) it just wipes out the entry. This makes me wonder if it’s something to do with the save as it’s not updating the record correctly. Also when the record is added manually the drop down doesn’t appear to pick it up.

Do you have caching going on perhaps that would slow down that display? Nope, no caching, I’ve tried it locally and there is nothing like w3cache or anything installed.

Many thanks for your help (and the plugin!) I really appreciate it.

Plugin Contributor

(@tw2113)

The BenchPresser

I’d get a new dropdown saved, if possible, via the UI that’s generated, and check the database to see how it’s structured in there. If your get_post_meta() calls are returning empty values, then I wager they’re either not saving properly somehow, or they’re being told to delete because “nothing was selected to be saved” in this case.

Thread Starter

(@tomarmstrong)

https://imgur.com/a/aiabl

Hello Micheal,

Many thanks for the fast reply!

I’d get a new dropdown saved, if possible, via the UI that’s generated, and check the database to see how it’s structured in there. By doing this I would be duplicating the current code to create the new drop down box, this will most likely create the same result as the issue I am currently facing.

I will give you some more information to help you understand this build as much as you can so that you can hopefully help me resolve this issue.

The website is built on a sage/roots starter theme, I have created templates for most pages that all have a series of metaboxes on for backend use.

I have added a number of Custom Post Types onto the website that I have created on https://generatewp.com/post-type/ .

With the theme, CMB2 (version”: “1.1.3”) and custom post types I am using categories, metaboxes and php loops to show a list of downloads.

From the front end view, on a specific template the user should see a list of downloads relevant to the page they are viewing, I have set up categories in the backend for the ‘forms’ custom post type (please see attached image link below).

To pick up the taxonomy of these categories I have used the ‘taxonomy_select’ metabox type:

array(
       'name'     => 'Downloads Category',
       'desc'     => 'Select the downloads category.',
       'id'       =>  $prefix . 'download_cat',
       'taxonomy' => 'form_category', //Enter Taxonomy Slug
       'type'     => 'taxonomy_select',
),

And then feed this onto the template using the following PHP:

$download_category = get_post_meta(get_the_ID(), '_ct_download_cat', true);

‘$download_category’ is then entered into a PHP loop to display in a list style on the front end:

<ul>
	<?php
		// the query
		$args = array(
		'post_type' => 'forms_pt',
		'orderby'=>'title',
		'order'=>'ASC',
		'posts_per_page' => 7,
		'tax_query' => array(
	        array(
		        'taxonomy' => 'form_category',
		        'field'    => 'id',
			'terms'    => $download_category,
		      ),
	           ),
                );

$the_query = new WP_Query( $args ); ?>

<?php if ( $the_query->have_posts() ) : ?>

<!-- pagination here -->

<!-- the loop -->
<?php while ( $the_query->have_posts() ) : $the_query->the_post();

	$file = get_post_meta(get_the_ID(),'form_download', true);

?>

	<li><a href="<?= $file; ?>"><?php the_title(); ?></a></li> 

<?php endwhile; ?>
<!-- end of the loop -->

<!-- pagination here -->

<?php wp_reset_postdata(); ?>

	<?php else : ?>
	     <p><?php _e( 'Sorry, no posts matched your criteria.' ); ?></p>
	<?php endif; ?>

</ul>

The admin user has the option to select what category of downloads they want to select on the front end by using the metabox drop down in the back end (please see image below).

https://imgur.com/a/lWAcz

I hope this can give you more of an understanding with what I am up against here, thanks again for the help so far!

Plugin Contributor

(@tw2113)

The BenchPresser

By doing this I would be duplicating the current code to create the new drop down box, this will most likely create the same result as the issue I am currently facing.

I worded that badly. I meant simply use the UI to save a new value. So you’d just go add or edit a post, use the metabox there, set a value, save, and then go check the database.

Is there reason why you’re using such an old version of CMB2? Is it a case of a bundled version with the theme?

Right now, the biggest question is why the post meta isn’t receiving data when saved, if I’m not mistaken. The second question is if it’d work if on the most recent version of the plugin, as 1.1.3 is from April 2014

nsrosenqvist

(@nsrosenqvist)

I seem to be unable to retrieve the value of a taxonomy select as well. Though in the admin ui it saves and shows my selection. When I retrieve it with get_post_meta it’s empty. Any recent changes in the code base that could have messed it up?

Plugin Contributor

(@tw2113)

The BenchPresser

nsrosenqvist, if you could please, start a fresh thread for your own issue, and provide all the code you’re using for your metaboxes, and we’ll get yours looked over there.

Thanks

Thread Starter

(@tomarmstrong)

Hello Micheal,

I worded that badly. I meant simply use the UI to save a new value. So you’d just go add or edit a post, use the metabox there, set a value, save, and then go check the database. I have tried this method from your intructions and unfortunately this does not make a change to the database. If I set the value needed in the database for a category the relevant list of downloads will appear on the front end, but when the drop down box is then changed in the back end the list disappears on the front end.

Is there reason why you’re using such an old version of CMB2? Is it a case of a bundled version with the theme? This website was built in 2014, using the released version of sage/roots starter theme at the time.

I have also added the following code to the metaboxes.php file:

<?php
/**
 * Include and setup custom metaboxes and fields. (make sure you copy this file to outside the CMB2 directory)
 *
 * Be sure to replace all instances of 'yourprefix_' with your project's prefix.
 * https://nacin.com/2010/05/11/in-wordpress-prefix-everything/
 *
 * @category YourThemeOrPlugin
 * @package  Demo_CMB2
 * @license  https://www.opensource.org/licenses/gpl-license.php GPL v2.0 (or later)
 * @link     https://github.com/WebDevStudios/CMB2
 */
/**
 * Get the bootstrap! If using the plugin from www.remarpro.com, REMOVE THIS!
 */
if ( file_exists( dirname( __FILE__ ) . '/cmb2/init.php' ) ) {
    require_once dirname( __FILE__ ) . '/cmb2/init.php';
} elseif ( file_exists( dirname( __FILE__ ) . '/CMB2/init.php' ) ) {
    require_once dirname( __FILE__ ) . '/CMB2/init.php';
}
/**
 * Conditionally displays a metabox when used as a callback in the 'show_on_cb' cmb2_box parameter
 *
 * @param  CMB2 object $cmb CMB2 object
 *
 * @return bool             True if metabox should show
 */
function yourprefix_show_if_front_page( $cmb ) {
    // Don't show this metabox if it's not the front page template
    if ( $cmb->object_id !== get_option( 'page_on_front' ) ) {
        return false;
    }
    return true;
}
/**
 * Conditionally displays a field when used as a callback in the 'show_on_cb' field parameter
 *
 * @param  CMB2_Field object $field Field object
 *
 * @return bool                     True if metabox should show
 */
function yourprefix_hide_if_no_cats( $field ) {
    // Don't show this field if not in the cats category
    if ( ! has_tag( 'cats', $field->object_id ) ) {
        return false;
    }
    return true;
}
/**
 * Manually render a field.
 *
 * @param  array      $field_args Array of field arguments.
 * @param  CMB2_Field $field      The field object
 */
function yourprefix_render_row_cb( $field_args, $field ) {
    $classes     = $field->row_classes();
    $id          = $field->args( 'id' );
    $label       = $field->args( 'name' );
    $name        = $field->args( '_name' );
    $value       = $field->escaped_value();
    $description = $field->args( 'description' );
    ?>
    <div class="custom-field-row <?php echo $classes; ?>">
        <p><label for="<?php echo $id; ?>"><?php echo $label; ?></label></p>
        <p><input id="<?php echo $id; ?>" type="text" name="<?php echo $name; ?>" value="<?php echo $value; ?>"/></p>
        <p class="description"><?php echo $description; ?></p>
    </div>
    <?php
}
/**
 * Manually render a field column display.
 *
 * @param  array      $field_args Array of field arguments.
 * @param  CMB2_Field $field      The field object
 */
function yourprefix_display_text_small_column( $field_args, $field ) {
    ?>
    <div class="custom-column-display <?php echo $field->row_classes(); ?>">
        <p><?php echo $field->escaped_value(); ?></p>
        <p class="description"><?php echo $field->args( 'description' ); ?></p>
    </div>
    <?php
}
/**
 * Conditionally displays a message if the $post_id is 2
 *
 * @param  array             $field_args Array of field parameters
 * @param  CMB2_Field object $field      Field object
 */
function yourprefix_before_row_if_2( $field_args, $field ) {
    if ( 2 == $field->object_id ) {
        echo '<p>Testing <b>"before_row"</b> parameter (on $post_id 2)</p>';
    } else {
        echo '<p>Testing <b>"before_row"</b> parameter (<b>NOT</b> on $post_id 2)</p>';
    }
}
add_action( 'cmb2_admin_init', 'yourprefix_register_demo_metabox' );
/**
 * Hook in and add a demo metabox. Can only happen on the 'cmb2_admin_init' or 'cmb2_init' hook.
 */

But this still does not work.

Do you have any more ideas/possible solutions?

Thanks again for the help so far!

Plugin Contributor

(@tw2113)

The BenchPresser

Add something like the following to your field declaration:

'sanitization_cb' => 'sanitize_text_field',

I traced my way through the code with the original field type, and the value was being returned as an empty string in an odd case of no sanitiztion callback being found as is. Explicitly providing one, caused the value to be returned like expected, and thus saved.

Plugin Contributor

(@tw2113)

The BenchPresser

For ease of possible setup, here’s the current code version I was using:

function cmb2_test_meta_boxes() {

	$prefix = '_ct_';

	$cmb_demo = new_cmb2_box( array(
		'id'           => 'service_default_custom_fields',
		'title'        => __( 'Service Custom Fields', 'ct' ),
		'object_types' => array( 'page', ),
		'context'  => 'normal',
		'priority' => 'high',
		'show_names' => true,
	) );

	$cmb_demo->add_field( array(
		'name'     => __( 'Downloads Categorys', 'cmb2' ),
		'desc'     => __( 'Select the downloads category.', 'cmb2' ),
		'id'       => $prefix . 'download_cat',
		'type'     => 'taxonomy_select',
		'taxonomy' => 'form_category',
		'sanitization_cb' => 'sanitize_text_field',
	) );
}
add_filter( 'cmb2_meta_boxes', 'cmb2_test_meta_boxes' );

Amend as necessary for your own usecase.

Thread Starter

(@tomarmstrong)

Hello Micheal,

I added the following line of code to my existing metabox code:

'sanitization_cb' => 'sanitize_text_field',

Unfortunately this did not work and in result made things worse. Once this line of code was added the drop down box on the back end page editor was not saving, where as before it was but it doesn’t work on the front end.

array(
     'name'     => 'Downloads Category',
     'desc'     => 'Select the downloads category.',
     'id'       =>  $prefix . 'download_cat_test',
     'type'     => 'taxonomy_select',
     'taxonomy' => 'form_category',
     'sanitization_cb' => 'sanitize_text_field',
),

Thread Starter

(@tomarmstrong)

Hello Micheal,

Since my earlier reply I have had a further look into this issue.

When sanitize is added it adds the entry to the postmeta table. I have also managed to get the category of downloads to display on the page using:

$download_category = get_post_meta(get_the_ID(), '_ct_contact_download_cat', true);

//echo $download_category;
global $wpdb;
                    $sql='select term_id from wp_qzsny57q7q_terms where slug = "'.$download_category.'"';
                    $posts = $wpdb->get_results($sql);
                    //print_r($posts);

                    foreach ($posts as $post)
                    {
                        //$post->FIELD1                         

                        $category_id = $post->term_id;
                    }

?>

However, the drop down meta box (taxonomy select) in the page editor does not pull the correct category id from the postmeta table.

So for instance, you can select a different category from the drop down and save it to the database but this does not update in the metabox on the edit page.

I have stripped back the full websites code until I resolve this issue, please see the metabox.php code below:

<?php
/**
 * Include and setup custom metaboxes and fields. (make sure you copy this file to outside the CMB2 directory)
 *
 * Be sure to replace all instances of 'yourprefix_' with your project's prefix.
 * https://nacin.com/2010/05/11/in-wordpress-prefix-everything/
 *
 * @category YourThemeOrPlugin
 * @package  Demo_CMB2
 * @license  https://www.opensource.org/licenses/gpl-license.php GPL v2.0 (or later)
 * @link     https://github.com/WebDevStudios/CMB2
 */

/**
 * Get the bootstrap! If using the plugin from www.remarpro.com, REMOVE THIS!
 */

if ( file_exists( dirname( __FILE__ ) . '/cmb2/init.php' ) ) {
    require_once dirname( __FILE__ ) . '/cmb2/init.php';
} elseif ( file_exists( dirname( __FILE__ ) . '/CMB2/init.php' ) ) {
    require_once dirname( __FILE__ ) . '/CMB2/init.php';
}

/**
 * Conditionally displays a metabox when used as a callback in the 'show_on_cb' cmb2_box parameter
 *
 * @param  CMB2 object $cmb CMB2 object
 *
 * @return bool             True if metabox should show
 */
function ct_show_if_front_page( $cmb ) {
    // Don't show this metabox if it's not the front page template
    if ( $cmb->object_id !== get_option( 'page_on_front' ) ) {
        return false;
    }
    return true;
}

/**
 * Conditionally displays a field when used as a callback in the 'show_on_cb' field parameter
 *
 * @param  CMB2_Field object $field Field object
 *
 * @return bool                     True if metabox should show
 */
function ct_hide_if_no_cats( $field ) {
    // Don't show this field if not in the cats category
    if ( ! has_tag( 'cats', $field->object_id ) ) {
        return false;
    }
    return true;
}

/**
 * Manually render a field.
 *
 * @param  array      $field_args Array of field arguments.
 * @param  CMB2_Field $field      The field object
 */
function ct_render_row_cb( $field_args, $field ) {
    $classes     = $field->row_classes();
    $id          = $field->args( 'id' );
    $label       = $field->args( 'name' );
    $name        = $field->args( '_name' );
    $value       = $field->escaped_value();
    $description = $field->args( 'description' );
    ?>
    <div class="custom-field-row <?php echo $classes; ?>">
        <p><label for="<?php echo $id; ?>"><?php echo $label; ?></label></p>
        <p><input id="<?php echo $id; ?>" type="text" name="<?php echo $name; ?>" value="<?php echo $value; ?>"/></p>
        <p class="description"><?php echo $description; ?></p>
    </div>
    <?php
}

/**
 * Manually render a field column display.
 *
 * @param  array      $field_args Array of field arguments.
 * @param  CMB2_Field $field      The field object
 */
function ct_display_text_small_column( $field_args, $field ) {
    ?>
    <div class="custom-column-display <?php echo $field->row_classes(); ?>">
        <p><?php echo $field->escaped_value(); ?></p>
        <p class="description"><?php echo $field->args( 'description' ); ?></p>
    </div>
    <?php
}

/**
 * Conditionally displays a message if the $post_id is 2
 *
 * @param  array             $field_args Array of field parameters
 * @param  CMB2_Field object $field      Field object
 */
function ct_before_row_if_2( $field_args, $field ) {
    if ( 2 == $field->object_id ) {
        echo '<p>Testing <b>"before_row"</b> parameter (on $post_id 2)</p>';
    } else {
        echo '<p>Testing <b>"before_row"</b> parameter (<b>NOT</b> on $post_id 2)</p>';
    }
}

add_action( 'cmb2_admin_init', 'yourprefix_register_demo_metabox' );
/**
 * Hook in and add a demo metabox. Can only happen on the 'cmb2_admin_init' or 'cmb2_init' hook.
 */
/***** HOME PAGE START *****/
add_action( 'cmb2_init', 'ct_register_contact_page_metabox' );
/**
 * Hook in and add a metabox that only appears on the 'home' page
 */
function ct_register_contact_page_metabox() {

    // Start with an underscore to hide fields from custom fields list
    $prefix = '_ct_contact_';

    /**
     * Metabox to be displayed on a single page ID
     */
    $cmb_contact_page = new_cmb2_box( array(
        'id'           => $prefix . 'metabox',
        'title'        => __( 'home Page Metabox', 'cmb2' ),
        'object_types' => array( 'page', ), // Post type
        'context'      => 'normal',
        'priority'     => 'high',
        'show_names'   => true, // Show field names on the left
        'show_on'      => array( 'key' => 'page-template', 'value' => 'template-service-default.php' ),
    ) );

    $cmb_contact_page->add_field( array(
        'name'     => __( 'Downloads Categorys', 'cmb2' ),
        'desc'     => __( 'Select the downloads category.', 'cmb2' ),
        'id'       => $prefix . 'download_cat',
        'type'     => 'taxonomy_select',
        'taxonomy' => 'form_category',
        'sanitization_cb' => 'sanitize_text_field',
    ) );

Here is the nessesary code from the php template:

<?php 

/*
Template Name: Single Service Template Default
*/

$download_category = get_post_meta(get_the_ID(), '_ct_contact_download_cat', true);

//echo $download_category;
global $wpdb;
                    $sql='select term_id from wp_qzsny57q7q_terms where slug = "'.$download_category.'"';
                    $posts = $wpdb->get_results($sql);
                    //print_r($posts);

                    foreach ($posts as $post)
                    {
                        //$post->FIELD1                         

                        $category_id = $post->term_id;
                    }

?>

<ul>
	<?php
	// the query
	$args = array(
		'post_type' => 'forms_pt',
		'orderby'=>'title',
		'order'=>'ASC',
		'posts_per_page' => 7,
		'tax_query' => array(
		array(
			'taxonomy' => 'form_category',
			'field'    => 'id',
			'terms'    => $category_id,
			),
		),
	);

	$the_query = new WP_Query( $args ); ?>

		<?php if ( $the_query->have_posts() ) : ?>

		<!-- pagination here -->

		<!-- the loop -->
		<?php while ( $the_query->have_posts() ) : $the_query->the_post();

	?>

	<li><a href="<?= $file; ?>"><?php the_title(); ?></a></li> 

	<?php endwhile; ?>
	<!-- end of the loop -->

	<!-- pagination here -->

	<?php wp_reset_postdata(); ?>

	<?php else : ?>
		<p><?php _e( 'Sorry, no posts matched your criteria.' ); ?></p>
	<?php endif; ?>

	<li><a href="/downloads/">View All Forms</a></li>
</ul>

Again, many thanks for all of your help and support so far, I feel that we are 90% of the way there now!

Plugin Contributor

(@tw2113)

The BenchPresser

However, the drop down meta box (taxonomy select) in the page editor does not pull the correct category id from the postmeta table.
Not quite following here.

The metabox portion above saves as slugs in the database, and that’s what’s stored on the post meta. In your template portion, you do a query for the term ID, based on provided term slug in the post meta field. With that, you grab all the posts from the forms_pt post type that have that term. Hopefully get results.

I’ve set it up on my own localhost, though i’m borrowing the page post type instead. I’m managing to get results in the template. What spot exactly is still failing on your part?

Plugin Contributor

(@tw2113)

The BenchPresser

Ok, so I spent an hour this evening working my way through this, checking a bunch of things in the code, when finally something occurred to me.

The taxonomy_* field types aren’t *supposed* to save to post meta. The chosen value(s) get assigned to the object in question. In your case above, it’s the “page” post type. Going back to your original post at the very start, I think the field type isn’t the best option for you.

It also explains why overtaking the sanitization_cb field worked for me earlier. When I set one, it simply saved the term slug as the post meta, instead of falling back to the default sanitization, which got changed in https://github.com/WebDevStudios/CMB2/commit/05f3a8a115ada46cf50018af4b294231942be343 Because of this commit, it no longer returned a value, but it still ran through wp_set_object_terms().

What may be worth tinkering with, since the taxonomy_* field types already populate for you, would be setting the sanitization_cb parameter so that it does end up saving the chosen slug to post meta, and continue from there. Otherwise, it’d perhaps be best to revert to a standard select field type and collect the terms yourself somehow for the available options. Kind of up to you.

I first thought the commit above was a bug, but about that point, it clicked in me what the taxonomy_* fields are meant for, and realized it wasn’t a bug. They’re for setting the terms for the post being edited, not for setting a term to be used elsewhere and for other things.

Plugin Author

Justin Sternberg

(@jtsternberg)