Pre-Populating a Form Field with something other than its default value

I’m having a strange problem. I am constructing a form with checkboxes to toggle email subscription preferences on and off. For the new user sign-up form, this is straightforward:

$form['marketing-container']['restaurant_newsletter_subscription'] = array(     '#type' => 'checkbox',     '#title' => t('Subscribe to Restaurant Newsletter'),     '#return_value' => "True",     '#default_value' => "False", ); 

However, when it comes to the update user form, I’m running into a problem. If I set #default_value to the existing preference, it will check the boxes for those publications you’re subscribed to correctly, but if you UNcheck those boxes, the form API just returns the default value….which would still be TRUE.

To work around this, I retrieved the subscriber object at the start of the form function, and I’ve added hidden fields whose default values are the existing subscription preference values, just like I attempted to do with the real fields in the first place. Then, I used #states to populate the real fields based on these hidden fields, like so:

$form['marketing-container']['existing_restaurant_newsletter_subscription'] = array(     '#type' => 'checkbox',     '#title' => t('Restaurant Newsletter'),     '#value' => $attributes[15]->Value, );  $form['marketing-container']['restaurant_newsletter_subscription'] = array(     '#type' => 'checkbox',     '#title' => t('Subscribe to Restaurant Newsletter'),     '#return_value' => "True",     '#default_value' => "False",     '#states' => array(         'checked' => array(             ':input[name="existing_restaurant_newsletter_subscription"]' => array('checked' => TRUE)         )     ) ); 

Now this works! The problem is that the first field is visible. Now if I alter this to hide the field:

$form['marketing-container']['existing_restaurant_newsletter_subscription'] = array(     '#type' => 'checkbox',     '#title' => t('Restaurant Newsletter'),     '#value' => $attributes[15]->Value,     '#access' => FALSE, ); 

The field is hidden perfectly….but its value isn’t copied over to the real field that’s still visible.

I’ve searched all over and pored over the Form API documentation, and I’m stumped.

Is there some way to preserve this default value inside the hidden form so it copies over to another field correctly?

If there isn’t, or if it’s more efficient, is there a DIFFERENT method I could use to pre-check this checkbox but still keep a default value of FALSE so that if a user unchecks it, something actually happens? Is there another class of field I’m missing that is a sort of on-off switch that returns specified values for each state?

This article was republished from its original source.
Call Us: 1(800)730-2416

Pixeldust is a 20-year-old web development agency specializing in Drupal and WordPress and working with clients all over the country. With our best in class capabilities, we work with small businesses and fortune 500 companies alike. Give us a call at 1(800)730-2416 and let’s talk about your project.

FREE Drupal SEO Audit

Test your site below to see which issues need to be fixed. We will fix them and optimize your Drupal site 100% for Google and Bing. (Allow 30-60 seconds to gather data.)

Powered by

Pre-Populating a Form Field with something other than its default value

On-Site Drupal SEO Master Setup

We make sure your site is 100% optimized (and stays that way) for the best SEO results.

With Pixeldust On-site (or On-page) SEO we make changes to your site’s structure and performance to make it easier for search engines to see and understand your site’s content. Search engines use algorithms to rank sites by degrees of relevance. Our on-site optimization ensures your site is configured to provide information in a way that meets Google and Bing standards for optimal indexing.

This service includes:

  • Pathauto install and configuration for SEO-friendly URLs.
  • Meta Tags install and configuration with dynamic tokens for meta titles and descriptions for all content types.
  • Install and fix all issues on the SEO checklist module.
  • Install and configure XML sitemap module and submit sitemaps.
  • Install and configure Google Analytics Module.
  • Install and configure Yoast.
  • Install and configure the Advanced Aggregation module to improve performance by minifying and merging CSS and JS.
  • Install and configure Schema.org Metatag.
  • Configure robots.txt.
  • Google Search Console setup snd configuration.
  • Find & Fix H1 tags.
  • Find and fix duplicate/missing meta descriptions.
  • Find and fix duplicate title tags.
  • Improve title, meta tags, and site descriptions.
  • Optimize images for better search engine optimization. Automate where possible.
  • Find and fix the missing alt and title tag for all images. Automate where possible.
  • The project takes 1 week to complete.