Skip to content

Reafactored: Add Settings Validation and Input Field Enhancements #285

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

Open
dev-alamin wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Reafactored: Add Settings Validation and Input Field Enhancements #285

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
99 changes: 79 additions & 20 deletions src/Modules/Settings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,14 @@ public function init(): void {
* @return void
*/
public function register_settings(): void {
register_setting( 'wp_google_login', 'wp_google_login_settings' );
register_setting(
'wp_google_login',
'wp_google_login_settings',
[
'sanitize_callback' => [ $this, 'validate_settings' ],
'default' => [],
]
);

add_settings_section(
'wp_google_login_section',
Expand Down Expand Up @@ -171,7 +178,7 @@ function () {
*/
public function client_id_field(): void {
?>
<input type='text' name='wp_google_login_settings[client_id]' id="client-id" value='<?php echo esc_attr( $this->client_id ); ?>' autocomplete="off" <?php $this->disabled( 'client_id' ); ?> />
<input class="regular-text" required type='text' name='wp_google_login_settings[client_id]' id="client-id" value='<?php echo esc_attr( $this->client_id ); ?>' autocomplete="off" <?php $this->disabled( 'client_id' ); ?> />
<p class="description">
<?php
echo wp_kses_post(
Expand All @@ -194,7 +201,7 @@ public function client_id_field(): void {
*/
public function client_secret_field(): void {
?>
<input type='password' name='wp_google_login_settings[client_secret]' id="client-secret" value='<?php echo esc_attr( $this->client_secret ); ?>' autocomplete="off" <?php $this->disabled( 'client_secret' ); ?> />
<input class="regular-text " required type='password' name='wp_google_login_settings[client_secret]' id="client-secret" value='<?php echo esc_attr( $this->client_secret ); ?>' autocomplete="off" <?php $this->disabled( 'client_secret' ); ?> />
<?php
}

Expand Down Expand Up @@ -274,22 +281,22 @@ public function one_tap_login_screens(): void {
<?php
// phpcs:disable
?>
<script type="text/javascript">
jQuery(document).ready(function () {
var toggle = function () {
var enabled = jQuery("#one-tap-login").is(":checked");
var tr_elem = jQuery("#one-tap-login-screen-login").parents("tr");
if (enabled) {
tr_elem.show();
return;
}

tr_elem.hide();
};
jQuery("#one-tap-login").on('change', toggle);
toggle();
});
</script>
<script type="text/javascript">
jQuery(document).ready(function () {
var toggle = function () {
var enabled = jQuery("#one-tap-login").is(":checked");
var tr_elem = jQuery("#one-tap-login-screen-login").parents("tr");
if (enabled) {
tr_elem.show();
return;
}

tr_elem.hide();
};
jQuery("#one-tap-login").on('change', toggle);
toggle();
});
</script>
<?php
// phpcs:enable
}
Expand All @@ -306,7 +313,7 @@ public function one_tap_login_screens(): void {
*/
public function whitelisted_domains(): void {
?>
<input <?php $this->disabled( 'whitelisted_domains' ); ?> type='text' name='wp_google_login_settings[whitelisted_domains]' id="whitelisted-domains" value='<?php echo esc_attr( $this->whitelisted_domains ); ?>' autocomplete="off" />
<textarea class="regular-text" <?php $this->disabled( 'whitelisted_domains' ); ?> name='wp_google_login_settings[whitelisted_domains]' id="whitelisted-domains" value='<?php echo esc_attr( $this->whitelisted_domains ); ?>' autocomplete="off"> </textarea>
<p class="description">
<?php echo esc_html( __( 'Add each domain comma separated', 'login-with-google' ) ); ?>
</p>
Expand Down Expand Up @@ -368,4 +375,56 @@ private function disabled( string $id ): void {
}
}
}

/**
* Validate settings before saving.
* @param array $input Input settings.
* @return array Validated settings.
*
* @since Next release
*/
public function validate_settings( array $input ) : array {
$new_input = [];
$is_valid = true;

// Client ID Validation (Required Field)
$client_id = sanitize_text_field( $input['client_id'] ?? '' );
if( empty( $client_id ) ) {
// Add error notice if saving with an emtpty ID
add_settings_error(
'wp_google_login_settings',
'client_id_required',
__( 'Client ID is required for the "Login with Google" plugin to function.', 'login-with-google' ),
'error'
);
$is_valid = false;
}
$new_input['client_id'] = $client_id;

// Client Secret Validation (Required Field)
$client_secret = sanitize_text_field( $input['client_secret'] ?? '' );
if ( empty( $client_secret ) ) {
add_settings_error(
'wp_google_login_settings',
'client_secret_required',
__( 'Client Secret is required for the "Login with Google" plugin to function.', 'login-with-google' ),
'error'
);
$is_valid = false;
}
$new_input['client_secret'] = $client_secret;

// Sanitize other fields
$new_input['whitelisted_domains'] = sanitize_textarea_field( $input['whitelisted_domains'] ?? '' );
$new_input['registration_enabled'] = ( isset( $input['registration_enabled'] ) && '1' === $input['registration_enabled'] ) ? '1' : '';
$new_input['one_tap_login'] = ( isset( $input['one_tap_login'] ) && '1' === $input['one_tap_login'] ) ? '1' : '';
$new_input['one_tap_login_screen'] = in_array( $input['one_tap_login_screen'] ?? '', [ 'login', 'sitewide' ], true ) ? $input['one_tap_login_screen'] : 'login';

// If validation failed, return the old options to prevent the empty fields from saving
if( ! $is_valid ) {
return $this->options;
}

return $new_input;
}
}