Skip to content

GH-28 Refactor code to add setting fields from an array #32

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
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

GH-28 Refactor code to add setting fields from an array #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
91830b4
Register script settings as an array
sudhir-yadav Feb 3, 2023
43f4cda
Ignore code editor files
sudhir-yadav Feb 3, 2023
9f56d9c
Refactor code to add setting fields from an array
sudhir-yadav Feb 3, 2023
140b395
Fix whitespace issue
sudhir-yadav Feb 3, 2023
95d7c51
Fix sections key for the add_settings_field function
sudhir-yadav Feb 3, 2023
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,6 @@ node_modules/
*.log
*.sql
*.sqlite

# ignore code editor files
.idea
162 changes: 82 additions & 80 deletions includes/settings-page.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,94 +13,96 @@
function rt_settings_init() {

// Register new setting options.
register_setting( 'rt-scripts-optimizer-settings', 'rt_scripts_optimizer_exclude_paths' );
register_setting( 'rt-scripts-optimizer-settings', 'rt_scripts_optimizer_exclude_handles' );
register_setting( 'rt-scripts-optimizer-settings', 'rt_scripts_optimizer_style_dequeue_non_logged_handles' );
register_setting( 'rt-scripts-optimizer-settings', 'rt_scripts_optimizer_style_async_handles' );
register_setting( 'rt-scripts-optimizer-settings', 'rt_scripts_optimizer_style_async_handles_onevent' );
register_setting( 'rt-scripts-optimizer-settings', 'rt_scripts_optimizer_load_amp_boilerplate_style' );
register_setting( 'rt-scripts-optimizer-settings', 'rt_scripts_optimizer_skip_css_concatination_all' );
register_setting( 'rt-scripts-optimizer-settings', 'rt_scripts_optimizer_skip_css_concatination_handles' );
$script_settings = [
'rt_scripts_optimizer_exclude_paths' => [
'id' => 'rt_scripts_optimizer_path_field',
'title' => __( 'Load js normally by adding script path here', 'RT_Script_Optimizer' ),
'callback' => 'rt_scripts_optimizer_paths_field_callback',
'page' => 'rt-scripts-optimizer-settings',
'section' => 'rt_scripts_optimizer_settings_section'
],
'rt_scripts_optimizer_exclude_handles' => [
'id' => 'rt_scripts_optimizer_handle_field',
'title' => __( 'Load js normally by adding script handles', 'RT_Script_Optimizer' ),
'callback' => 'rt_scripts_optimizer_handles_field_callback',
'page' => 'rt-scripts-optimizer-settings',
'section' => 'rt_scripts_optimizer_settings_section'
],
'rt_scripts_optimizer_style_dequeue_non_logged_handles' => [
'id' => 'rt_scripts_optimizer_style_dequeue_non_logged_handles',
'title' => __( 'CSS handles of the stylesheets which should not be loaded if user not logged in', 'RT_Script_Optimizer' ),
'callback' => 'rt_scripts_optimizer_style_dequeue_non_logged_handles_callback',
'page' => 'rt-scripts-optimizer-settings',
'section' => 'rt_scripts_optimizer_settings_section'
],
'rt_scripts_optimizer_style_async_handles' => [
'id' => 'rt_scripts_optimizer_style_async_handles',
'title' => __( 'CSS handles of the stylesheets which should be asynchronously loaded', 'RT_Script_Optimizer' ),
'callback' => 'rt_scripts_optimizer_style_async_handles_callback',
'page' => 'rt-scripts-optimizer-settings',
'section' => 'rt_scripts_optimizer_settings_section'
],
'rt_scripts_optimizer_style_async_handles_onevent' => [
'id' => 'rt_scripts_optimizer_style_async_handles_onevent',
'title' => __( 'CSS handles of the stylesheets which should be asynchronously loaded on any window event', 'RT_Script_Optimizer' ),
'callback' => 'rt_scripts_optimizer_style_async_handles_onevent_callback',
'page' => 'rt-scripts-optimizer-settings',
'section' => 'rt_scripts_optimizer_settings_section'
],
'rt_scripts_optimizer_load_amp_boilerplate_style' => [
'id' => 'rt_scripts_optimizer_load_amp_boilerplate_style',
'title' => __( 'Load AMP boilerplate CSS', 'RT_Script_Optimizer' ),
'callback' => 'rt_scripts_optimizer_load_amp_boilerplate_style_callback',
'page' => 'rt-scripts-optimizer-settings',
'section' => 'rt_scripts_optimizer_settings_section'
],
'rt_scripts_optimizer_skip_css_concatination_all' => [
'id' => 'rt_scripts_optimizer_skip_css_concatination_all',
'title' => __( 'Skip all CSS concatination', 'RT_Script_Optimizer' ),
'callback' => 'rt_scripts_optimizer_skip_css_concatination_all_callback',
'page' => 'rt-scripts-optimizer-settings',
'section' => 'rt_scripts_optimizer_settings_section'
],
'rt_scripts_optimizer_skip_css_concatination_handles' => [
'id' => 'rt_scripts_optimizer_skip_css_concatination_handles',
'title' => __( 'Skip CSS concatination for these handles', 'RT_Script_Optimizer' ),
'callback' => 'rt_scripts_optimizer_skip_css_concatination_handles_callback',
'page' => 'rt-scripts-optimizer-settings',
'section' => 'rt_scripts_optimizer_settings_section'
]
];

/**
* Add fields from settings array to following core functions.
*
* add_settings_field( $id, $title, $callback, $page, $section )
* - https://developer.wordpress.org/reference/functions/add_settings_field/
*
* register_setting( $option_group, $option_name )
* - https://developer.wordpress.org/reference/functions/register_setting/
*
*/
foreach ( $script_settings as $option_name => $settings ) {

add_settings_field(
$settings[ 'id' ],
$settings[ 'title' ],
$settings[ 'callback' ],
$settings[ 'page' ],
$settings[ 'section' ]
);

register_setting( 'rt-scripts-optimizer-settings', $option_name );
Comment on lines +85 to +95
Copy link
Contributor

@hbhalodia hbhalodia Feb 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @sudhir-yadav @pradeep910, This is the exact same code that we had earlier just shorten by adding a foreach loop. I think we need to register only 1 settings and fetch other settings by array key. Something similar to below code.

// Define default array
$defaults = array(
   'setting_1' => 'default_value_1',
   'setting_2' => 'default_value_2',
);

// Register the setting
register_setting( 'my_settings_group', 'my_array_setting', array(
   'type' => 'array',
   'default' => $defaults,
) );

// Update code that uses the setting
$options = get_option( 'my_array_setting', $defaults );
$setting_1 = $options['setting_1'];
$setting_2 = $options['setting_2'];

Of course we need to handle for the settings that are saved with standalone options after implementing above. This is my suggestion, and it would best because we need to call just one option and that would be stored in an array we can fetch by array key.

Copy link
Contributor

@hbhalodia hbhalodia Feb 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also settings callback would be same, there would be no change, just option fetch from settings key.

}

// Register a new section.
add_settings_section(
'rt_scripts_optimizer_settings_section', // ID.
__( 'RT Scripts Optimizer Settings', 'RT_Script_Optimizer' ), // Title.
__( 'RT Scripts Optimizer Settings', 'RT_Script_Optimizer' ), // Title.
'rt_scripts_optimizer_settings_callback', // Callback Function.
'rt-scripts-optimizer-settings' // Page.
);

// Register a new field to fetch paths of scripts to exclude.
add_settings_field(
'rt_scripts_optimizer_path_field', // As of WP 4.6 this value is used only internally.
__( 'Load js normally by adding script path here', 'RT_Script_Optimizer' ), // Title.
'rt_scripts_optimizer_paths_field_callback', // Callback Function.
'rt-scripts-optimizer-settings', // Page.
'rt_scripts_optimizer_settings_section' // Section.
);

// Register a new field to fetch handles of scripts to exclude.
add_settings_field(
'rt_scripts_optimizer_handle_field', // As of WP 4.6 this value is used only internally.
__( 'Load js normally by adding script handles', 'RT_Script_Optimizer' ), // Title.
'rt_scripts_optimizer_handles_field_callback', // Callback Function.
'rt-scripts-optimizer-settings', // Page.
'rt_scripts_optimizer_settings_section' // Section.
);

// Register a new field to fetch handles of styles to be dequeued for non-logged in users.
add_settings_field(
'rt_scripts_optimizer_style_dequeue_non_logged_handles', // As of WP 4.6 this value is used only internally.
__( 'CSS handles of the stylesheets which should not be loaded if user not logged in', 'RT_Script_Optimizer' ), // Title.
'rt_scripts_optimizer_style_dequeue_non_logged_handles_callback', // Callback Function.
'rt-scripts-optimizer-settings', // Page.
'rt_scripts_optimizer_settings_section' // Section.
);

// Register a new field to fetch handles of styles to be loaded async.
add_settings_field(
'rt_scripts_optimizer_style_async_handles', // As of WP 4.6 this value is used only internally.
__( 'CSS handles of the stylesheets which should be asynchronously loaded', 'RT_Script_Optimizer' ), // Title.
'rt_scripts_optimizer_style_async_handles_callback', // Callback Function.
'rt-scripts-optimizer-settings', // Page.
'rt_scripts_optimizer_settings_section' // Section.
);

// Register a new field to fetch handles of styles to be loaded on any window event.
add_settings_field(
'rt_scripts_optimizer_style_async_handles_onevent', // As of WP 4.6 this value is used only internally.
__( 'CSS handles of the stylesheets which should be asynchronously loaded on any window event', 'RT_Script_Optimizer' ), // Title.
'rt_scripts_optimizer_style_async_handles_onevent_callback', // Callback Function.
'rt-scripts-optimizer-settings', // Page.
'rt_scripts_optimizer_settings_section' // Section.
);

// Register a new field to fetch option whether to load amp-boilerplate style.
add_settings_field(
'rt_scripts_optimizer_load_amp_boilerplate_style', // As of WP 4.6 this value is used only internally.
__( 'Load AMP boilerplate CSS', 'RT_Script_Optimizer' ), // Title.
'rt_scripts_optimizer_load_amp_boilerplate_style_callback', // Callback Function.
'rt-scripts-optimizer-settings', // Page.
'rt_scripts_optimizer_settings_section' // Section.
);

// Register a new field to fetch option whether to skip all CSS concatination.
add_settings_field(
'rt_scripts_optimizer_skip_css_concatination_all', // As of WP 4.6 this value is used only internally.
__( 'Skip all CSS concatination', 'RT_Script_Optimizer' ), // Title.
'rt_scripts_optimizer_skip_css_concatination_all_callback', // Callback Function.
'rt-scripts-optimizer-settings', // Page.
'rt_scripts_optimizer_settings_section' // Section.
);

// Register a new field to fetch handles of stylesheets which are not to be concated.
add_settings_field(
'rt_scripts_optimizer_skip_css_concatination_handles', // As of WP 4.6 this value is used only internally.
__( 'Skip CSS concatination for these handles', 'RT_Script_Optimizer' ), // Title.
'rt_scripts_optimizer_skip_css_concatination_handles_callback', // Callback Function.
'rt-scripts-optimizer-settings', // Page.
'rt_scripts_optimizer_settings_section' // Section.
);
}

/**
Expand Down