Forms: Fixes checkbox checked state for admins

[enejb]

Fixes #14912

Currently when a user adds a checkbox and sets the default state to be "checked" the admin user doesn't see the checked state when logged in when they see the form.

This was done because we didn't want to pre-fill any of the user info fields for admins. (this includes super admins)

This PR fixes this by making sure that we only setting the user value for a specific set of fields (name, email and url) and only if they are admins.

THis PR also fixes an issues where we were not able to pre fill form fields for admin users if they are passed in via the POST or get parameters.

A number of tests were added to show that things still work as before.

Before (Logged in admin user)

After ( Logged in user)

Logged in admin user

Logged out user

Proposed changes:

Fix the checked default setting for logged in users.

Other information:

• Have you written new tests for your changes, if applicable?
• Have you checked the E2E test CI results, and verified that your changes do not break them?
• Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

Load this PR on a jetpack site and .com simple ( bin/jetpack-downloader test jetpack fix/checkbox-checked-state )

1. Create a new page.
2. Add the form block and then add the checkbox block.
3. In the setting for the checkbox block set the default value as checked.
4. Notice now when you preview the form that the checkbox is checked as expected.
5. Notice on .com we prefill the user data if they are not an admin of the site. For email, url and name fields.
6. Notice that you can pass in the value for the form using the $_GET query parameter.

[github-actions]

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

• To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the fix/checkbox-checked-state branch.

• To test on Simple, run the following command on your sandbox:

  bin/jetpack-downloader test jetpack fix/checkbox-checked-state
  

Interested in more tips and information?

• In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
• Read more about our development workflow here: PCYsg-eg0-p2
• Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

[github-actions]

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

• ✅ Include a description of your PR changes.
  
• ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  
• ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  
• ✅ Add testing instructions.
  
• ✅ Specify whether this PR includes any changes to data or privacy.
  
• ✅ Add changelog entries to affected projects
  

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

---

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

---

Follow this PR Review Process:

1. Ensure all required checks appearing at the bottom of this PR are passing.
2. Choose a review path based on your changes:
   • A. Team Review: add the "[Status] Needs Team Review" label
     • For most changes, including minor cross-team impacts.
     • Example: Updating a team-specific component or a small change to a shared library.
   • B. Crew Review: add the "[Status] Needs Review" label
     • For significant changes to core functionality.
     • Example: Major updates to a shared library or complex features.
   • C. Both: Start with Team, then request Crew
     • For complex changes or when you need extra confidence.
     • Example: Refactor affecting multiple systems.
3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

[edanzer]

Changes look simple and straightforward, and I confirmed both the original issue and the fix.

I'm curious about why we're not showing pre-populated fields for admins in the first place if those fields will be pre-populated for end users. I would have thought admins would want to see the form preview as it will render for end users.

UPDATE: Approving with a note that there seems to be a failing test that needs to be resolved. Looks like the change here is resulting in a type issue on the render_default_field method.

[ntsekouras]

Thanks for the PR!

I'm curious about why we're not showing pre-populated fields for admins in the first place if those fields will be pre-populated for end users. I would have thought admins would want to see the form preview as it will render for end users.

I'd echo this and a better fix IMO should be to remove this current_user_can( 'manage_options' ) check instead of trying to handle the specific checkbox type. I'm not sure of other types that could have a value like that, but they would have the same problem as here possibly.

[enejb]

@ice9js Do you have idea why we removing the pre-populated values for admins?

[ice9js]

That's from before the code was moved into the forms package - I believe it was introduced in #12018. Unfortunately I don't have any additional context myself. Hope this helps.

[enejb]

@kraftbj and @sixhours do you have context around this change?

See #12018 PR for more context.

[kraftbj]

@enej It comes from a Trello card that I long don't have access to (Fix the Flows) p1552681497000900-slack-CFWS1TRT4

My sense is there was confusion and concern when admins would add a contact form to their site and see their contact information already there... as if it was public on the page itself.