Skip to content

Forms: Fixes checkbox checked state for admins #40847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 23, 2025
Merged

Forms: Fixes checkbox checked state for admins #40847

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
689a3d6
Fix: #14912
enejb Jan 3, 2025
1d1c5b7
changelog
enejb Jan 3, 2025
efba70f
Fix the check that lets you prefills the form fields
enejb Jan 17, 2025
15f8729
Add tests
enejb Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions projects/packages/forms/changelog/fix-checkbox-checked-state
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Significance: patch
Type: fixed

Form: fix the default checkstate for admins
106 changes: 60 additions & 46 deletions projects/packages/forms/src/contact-form/class-contact-form-field.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,6 @@ public function get_option_value( $value, $index, $options ) {
* @return string HTML
*/
public function render() {
global $current_user, $user_identity;

$field_id = $this->get_attribute( 'id' );
$field_type = $this->maybe_override_type();
Expand Down Expand Up @@ -359,46 +358,7 @@ public function render() {
*/
$field_class = apply_filters( 'jetpack_contact_form_input_class', $class );

if ( isset( $_POST[ $field_id ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing -- no site changes.
if ( is_array( $_POST[ $field_id ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing -- no site changes.
$this->value = array_map( 'sanitize_textarea_field', wp_unslash( $_POST[ $field_id ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing -- no site changes.
} else {
$this->value = sanitize_textarea_field( wp_unslash( $_POST[ $field_id ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing -- no site changes.
}
} elseif ( isset( $_GET[ $field_id ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- no site changes.
$this->value = sanitize_textarea_field( wp_unslash( $_GET[ $field_id ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- no site changes.
} elseif (
is_user_logged_in() &&
( ( defined( 'IS_WPCOM' ) && IS_WPCOM ) ||
/**
* Allow third-party tools to prefill the contact form with the user's details when they're logged in.
*
* @module contact-form
*
* @since 3.2.0
*
* @param bool false Should the Contact Form be prefilled with your details when you're logged in. Default to false.
*/
true === apply_filters( 'jetpack_auto_fill_logged_in_user', false )
)
) {
// Special defaults for logged-in users
switch ( $field_type ) {
case 'email':
$this->value = $current_user->data->user_email;
break;
case 'name':
$this->value = $user_identity;
break;
case 'url':
$this->value = $current_user->data->user_url;
break;
default:
$this->value = $this->get_attribute( 'default' );
}
} else {
$this->value = $this->get_attribute( 'default' );
}
$this->value = $this->get_computed_field_value( $field_type, $field_id );

$field_value = Contact_Form_Plugin::strip_tags( $this->value );
$field_label = Contact_Form_Plugin::strip_tags( $field_label );
Expand All @@ -418,6 +378,65 @@ public function render() {
*/
return apply_filters( 'grunion_contact_form_field_html', $rendered_field, $field_label, ( in_the_loop() ? get_the_ID() : null ) );
}
/**
* Returns the computed field value for a field. It uses the POST, GET, Logged in data.
*
* @module contact-form
*
* @param string $field_type The field type.
* @param string $field_id The field id.
*
* @return string
*/
public function get_computed_field_value( $field_type, $field_id ) {
global $current_user, $user_identity;
// Use the POST Field if it is available.
if ( isset( $_POST[ $field_id ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing -- no site changes.
if ( is_array( $_POST[ $field_id ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing -- no site changes.
return array_map( 'sanitize_textarea_field', wp_unslash( $_POST[ $field_id ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing -- no site changes.
}

return sanitize_textarea_field( wp_unslash( $_POST[ $field_id ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing -- no site changes.
}

// Use the GET Field if it is available.
if ( isset( $_GET[ $field_id ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- no site changes.
if ( is_array( $_GET[ $field_id ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- no site changes.
return array_map( 'sanitize_textarea_field', wp_unslash( $_GET[ $field_id ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- no site changes.
}

return sanitize_textarea_field( wp_unslash( $_GET[ $field_id ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- no site changes.
}

if ( ! is_user_logged_in() ) {
return $this->get_attribute( 'default' );
}

/**
* Allow third-party tools to prefill the contact form with the user's details when they're logged in.
*
* @module contact-form
*
* @since 3.2.0
*
* @param bool false Should the Contact Form be prefilled with your details when you're logged in. Default to false.
*/
$filter_value = apply_filters( 'jetpack_auto_fill_logged_in_user', false );
if ( ( ! current_user_can( 'manage_options' ) && ( defined( 'IS_WPCOM' ) && IS_WPCOM ) ) || $filter_value ) {
switch ( $field_type ) {
case 'email':
return $current_user->data->user_email;

case 'name':
return ! empty( $user_identity ) ? $user_identity : $current_user->data->display_name;

case 'url':
return $current_user->data->user_url;
}
}

return $this->get_attribute( 'default' );
}

/**
* Return the HTML for the label.
Expand Down Expand Up @@ -1032,11 +1051,6 @@ public function render_field( $type, $id, $label, $value, $class, $placeholder,

$field .= "\n<div {$block_style} {$shell_field_class} >\n"; // new in Jetpack 6.8.0

// If they are logged in, and this is their site, don't pre-populate fields
if ( current_user_can( 'manage_options' ) ) {
$value = '';
}

switch ( $type ) {
case 'email':
$field .= $this->render_email_field( $id, $label, $value, $field_class, $required, $required_field_text, $field_placeholder );
Expand Down
162 changes: 162 additions & 0 deletions projects/packages/forms/tests/php/contact-form/test-class.contact-form-field.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
<?php
/**
* Unit Tests for Automattic\Jetpack\Forms\Contact_Form.
*
* @package automattic/jetpack-forms
*/

namespace Automattic\Jetpack\Forms\ContactForm;

use WorDBless\BaseTestCase;

/**
* Test class for Contact_Form
*
* @covers Automattic\Jetpack\Forms\ContactForm\Contact_Form
*/
class WP_Test_Contact_Form_Field extends BaseTestCase {

protected function setUp(): void {
parent::setUp();

// Mock global variables
global $user_identity;

$user_id = wp_insert_user(
array(
'user_login' => 'admin',
'user_pass' => 'pass',
'user_email' => '[email protected]',
'role' => 'reader',
'user_url' => 'https://example.com',
)
);

// Simulate a logged-in user
wp_set_current_user( $user_id );
$user_identity = 'Test User';
}

protected function tearDown(): void {
parent::tearDown();
global $current_user, $user_identity;

// Clean up globals
unset( $_POST, $_GET, $current_user, $user_identity );
}

/**
* Helper function to invoke the function from the class.
*/
private function invoke_get_computed_field_value( $field_type, $field_id ) {
$field = $this->get_new_field_instance(
array(
'type' => $field_type,
'id' => $field_id,
)
);
return $field->get_computed_field_value( $field_type, $field_id );
}

private function get_new_field_instance( $attributes ) {
$defaults = array(
'type' => 'text',
'id' => 'id',
'default' => 'default',
);

return new Contact_Form_Field( wp_parse_args( $attributes, $defaults ) );
}

/**
* Test handling $_POST single value
*/
public function test_handles_post_single_value() {
$_POST['test_field'] = 'Post Value';

$result = $this->invoke_get_computed_field_value( 'text', 'test_field' );

$this->assertEquals( 'Post Value', $result );
}

/**
* Test handling $_POST array value
*/
public function test_handles_post_array_value() {
$_POST['test_field'] = array( 'value1', 'value2' );

$result = $this->invoke_get_computed_field_value( 'text', 'test_field' );

$this->assertEquals( array( 'value1', 'value2' ), $result );
}

/**
* Test handling $_GET single value
*/
public function test_handles_get_single_value() {
$_GET['test_field'] = 'Get Value';

$result = $this->invoke_get_computed_field_value( 'text', 'test_field' );

$this->assertEquals( 'Get Value', $result );
}

/**
* Test handling $_GET array value
*/
public function test_handles_get_array_value() {
$_GET['test_field'] = array( 'value1', 'value2' );

$result = $this->invoke_get_computed_field_value( 'text', 'test_field' );

$this->assertEquals( array( 'value1', 'value2' ), $result );
}

/**
* Test logged-in user email return
*/
public function test_returns_logged_in_user_email() {
add_filter( 'jetpack_auto_fill_logged_in_user', '__return_true' );
$result = $this->invoke_get_computed_field_value( 'email', 'test_field' );
remove_filter( 'jetpack_auto_fill_logged_in_user', '__return_true' );

$this->assertEquals( '[email protected]', $result );
}

/**
* Test logged-in user name return
*/
public function test_returns_logged_in_user_name() {
add_filter( 'jetpack_auto_fill_logged_in_user', '__return_true' );
$result = $this->invoke_get_computed_field_value( 'name', 'test_field' );
remove_filter( 'jetpack_auto_fill_logged_in_user', '__return_true' );

$this->assertEquals( 'Test User', $result );
}

/**
* Test logged-in user URL return
*/
public function test_returns_logged_in_user_url() {
add_filter( 'jetpack_auto_fill_logged_in_user', '__return_true' );
$result = $this->invoke_get_computed_field_value( 'url', 'test_field' );
remove_filter( 'jetpack_auto_fill_logged_in_user', '__return_true' );

$this->assertEquals( 'https://example.com', $result );
}

/**
* Test logged-in user URL return
*/
public function test_returns_logged_out_user_url() {
global $current_user;
unset( $current_user );
wp_set_current_user( 0 );

add_filter( 'jetpack_auto_fill_logged_in_user', '__return_true' );
$result = $this->invoke_get_computed_field_value( 'url', 'test_field' );
remove_filter( 'jetpack_auto_fill_logged_in_user', '__return_true' );

$this->assertEquals( 'default', $result );
}
} // end class
Loading