get_sub_page_slug() ) === $sub_menu[2] ) {
remove_submenu_page( Init::MAIN_MENU_SLUG, Init::MAIN_MENU_SLUG . $this->get_sub_page_slug() );
}
}
}
$this->sub_page_hook = add_submenu_page(
Init::MAIN_MENU_SLUG,
$this->get_sub_page_title(),
$this->get_sub_page_title(),
'manage_options',
Init::MAIN_MENU_SLUG . $this->get_sub_page_slug(),
fn() => $this->display_content()
);
}
/**
* Registers all sections for a sub-page.
*
* @since 1.5.0
*/
public function add_settings_sections(): void {
$this->sections = array(
Settings::instance()->settings_sections['general']->get_section_slug() => Settings::instance()->settings_sections['general'],
Settings::instance()->settings_sections['referrers_and_tooltips']->get_section_slug() => Settings::instance()->settings_sections['referrers_and_tooltips'],
Settings::instance()->settings_sections['scope_and_priority']->get_section_slug() => Settings::instance()->settings_sections['scope_and_priority'],
Settings::instance()->settings_sections['custom_css']->get_section_slug() => Settings::instance()->settings_sections['custom_css'],
);
/*foreach ( $this->get_sections() as $section ) {
// Append tab to the tab-array.
$this->sections[ $section['id'] ] = $section;
add_settings_section(
$section['id'],
'',
fn() => $this->description(),
'footnotes'
);
$this->add_settings_fields();
//$this->register_meta_boxes( $section['id'] );
}*/
}
// phpcs:disable WordPress.Security.NonceVerification.Recommended, WordPress.Security.NonceVerification.Missing
/**
* Displays the content of specific sub-page.
*
* @since 1.5.0
* @todo Review nonce verification.
*/
public function display_content(): void {
// check user capabilities
if ( ! current_user_can( 'manage_options' ) ) {
return;
}
$active_section_id = isset( $_GET['t'] ) ? wp_unslash( $_GET['t'] ) : array_key_first( $this->sections );
$active_section = $this->sections[ $active_section_id ];
// Store settings.
$settings_updated = false;
if ( array_key_exists( 'save-settings', $_POST ) ) {
if ( 'save' === $_POST['save-settings'] ) {
unset( $_POST['save-settings'] );
unset( $_POST['submit'] );
$settings_updated = $this->save_settings();
}
}
?>
', __( 'Settings saved', 'footnotes' ) );
}
// show error/update messages
settings_errors( 'footnotes_messages' );
?>
$this->plugin_name . '-' . $id,
'title' => $title,
'submit' => $has_submit_button,
'container' => $settings_container_index,
);
}
/**
* Returns an array describing a meta box.
*
* @access protected
* @param string $section_id Parent section ID.
* @param string $id Unique ID suffix.
* @param string $title Title for the meta box.
* @param string $callback_function_name Class method name for callback.
* @return array {
* A dashboard meta box.
*
* @type string $parent Parent section ID.
* @type string $id Meta box ID.
* @type string $title Meta box title.
* @type string $callback Meta box callback function.
* }
*
* @since 1.5.0
* @todo Refactor meta boxes into their own class?
* @todo Pass actual functions rather than strings?
*/
protected function add_meta_box( string $section_id, string $id, string $title, string $callback_function_name ): array {
return array(
'parent' => $this->plugin_name . '-' . $section_id,
'id' => $id,
'title' => $title,
'callback' => $callback_function_name,
);
}
/**
* Loads a specified setting.
*
* @access protected
* @param string $setting_key_name Setting key.
* @return array {
* A configurable setting.
*
* @type string $id Setting key.
* @type string $name Setting name.
* @type string $value Setting value.
* }
*
* @since 1.5.0
* @since 2.5.11 Broken due to accidental removal of `esc_attr()` call.
* @since 2.6.1 Restore `esc_attr()` call.
*/
protected function load_setting( string $setting_key_name ): array {
// Get current section.
reset( $this->sections );
$return = array();
$return['id'] = $setting_key_name;
$return['name'] = $setting_key_name;
$return['value'] = esc_attr( Settings::instance()->get( $setting_key_name ) );
return $return;
}
/**
* Returns a simple text inside a 'span' element.
*
* @access protected
* @param string $text Message to be surrounded with `` tags.
*
* @since 1.5.0
* @todo Refactor HTML generation.
*/
protected function add_text( string $text ): string {
return sprintf( '%s', $text );
}
/**
* Returns the HTML tag for a 'label' element.
*
* @access protected
* @param string $setting_name Settings key.
* @param string $caption Label caption.
*
* @since 1.5.0
* @todo Refactor HTML generation.
*/
protected function add_label( string $setting_name, string $caption ): string {
if ( empty( $caption ) ) {
return '';
}
/*
* Remove the colon causing localization issues with French, and with
* languages not using punctuation at all, and with languages using other
* punctuation marks instead of colon, e.g. Greek using a raised dot.
* In French, colon is preceded by a space, forcibly non-breaking, and
* narrow per new school.
* Add colon to label strings for inclusion in localization. Colon after
* label is widely preferred best practice, mandatory per
* {@link https://softwareengineering.stackexchange.com/questions/234546/colons-in-internationalized-ui
* style guides}.
*/
return sprintf( '', $setting_name, $caption );
}
/**
* Constructs the HTML for a text 'input' element.
*
* @access protected
* @param string $setting_name Setting key.
* @param int $max_length Maximum length of the input. Default length 999 chars.
* @param bool $readonly Set the input to be read only. Default `false`.
* @param bool $hidden Set the input to be hidden. Default `false`.
*
* @since 1.5.0
* @todo Refactor HTML generation.
*/
protected function add_text_box( string $setting_name, int $max_length = 999, bool $readonly = false, bool $hidden = false ): string {
$style = '';
if ( $hidden ) {
$style .= 'display:none;';
}
return sprintf(
'',
$setting_name,
$setting_name,
$max_length,
$style,
get_option($setting_name),
$readonly ? 'readonly="readonly"' : ''
);
}
/**************************************************************************
* NEW METHODS
**************************************************************************/
protected function add_input_text( array $args ): void {
extract( $args );
echo ( sprintf(
'',
$name,
$name,
$max_length ?? 999,
$style ?? '',
$value,
isset($readonly) ? ' readonly="readonly"' : '',
$disabled ? ' disabled': ''
) );
}
protected function add_input_number( array $args ): void {
extract( $args );
echo ( sprintf(
'',
$name,
$name,
isset($max) ? ' max="'.$max.'"' : '',
isset($min) ? ' min="'.$min.'"' : '',
$value,
isset($readonly) ? ' readonly="readonly"' : '',
$disabled ? ' disabled': ''
) );
}
protected function add_input_select( array $args ): void {
extract( $args );
if (!isset($options)) trigger_error("No options passed to 'select' element.", E_USER_ERROR);
$select_options = '';
// Loop through all array keys.
foreach ( $options as $option_value => $option_text ) {
$select_options .= sprintf(
'',
$option_value,
// Only check for equality, not identity, WRT backlink symbol arrows.
// phpcs:disable WordPress.PHP.StrictComparisons.LooseComparison
$option_value == $value ? ' selected' : '',
// phpcs:enable WordPress.PHP.StrictComparisons.LooseComparison
$option_text
);
}
echo ( sprintf(
'',
$name,
$name,
$disabled ? ' disabled': '',
$select_options
) );
}
protected function add_input_checkbox( array $args ): void {
extract( $args );
echo sprintf(
'',
$name,
$name,
$value ? ' checked="checked"' : '',
$disabled ? ' disabled': ''
);
}
protected function add_input_color( array $args ): void {
extract( $args );
echo sprintf(
'',
$name,
$name,
$disabled ? ' disabled': ''
);
}
/**************************************************************************
* NEW METHODS END
**************************************************************************/
/**
* Constructs the HTML for a checkbox 'input' element.
*
* @access protected
* @param string $setting_name Setting key.
*
* @since 1.5.0
* @todo Refactor HTML generation.
*/
protected function add_checkbox( string $setting_name ): string {
// Collect data for given settings field.
$data = $this->load_setting( $setting_name );
return sprintf(
'',
$data['name'],
$data['id'],
Convert::to_bool( $data['value'] ) ? 'checked="checked"' : ''
);
}
/**
* Constructs the HTML for a 'select' element.
*
* @access protected
* @param string $setting_name Setting key.
* @param array $options Possible options.
*
* @since 1.5.0
* @todo Refactor HTML generation.
*/
protected function add_select_box( string $setting_name, array $options ): string {
// Collect data for given settings field.
$data = $this->load_setting( $setting_name );
$select_options = '';
// Loop through all array keys.
foreach ( $options as $value => $caption ) {
$select_options .= sprintf(
'',
$value,
// Only check for equality, not identity, WRT backlink symbol arrows.
// phpcs:disable WordPress.PHP.StrictComparisons.LooseComparison
$value == $data['value'] ? 'selected' : '',
// phpcs:enable WordPress.PHP.StrictComparisons.LooseComparison
$caption
);
}
return sprintf(
'',
$data['name'],
$data['id'],
$select_options
);
}
/**
* Constructs the HTML for a 'textarea' element.
*
* @access protected
* @param string $setting_name Setting key.
*
* @since 1.5.0
* @todo Refactor HTML generation.
*/
protected function add_textarea( $setting_name ): string {
// Collect data for given settings field.
$data = $this->load_setting( $setting_name );
return sprintf(
'',
$data['name'],
$data['id'],
$data['value']
);
}
/**
* Constructs the HTML for a text 'input' element with the colour selection
* class.
*
* @access protected
* @param string $setting_name Setting key.
*
* @since 1.5.6
* @todo Refactor HTML generation.
* @todo Use proper colorpicker element.
*/
protected function add_color_selection( string $setting_name ): string {
// Collect data for given settings field.
$data = $this->load_setting( $setting_name );
return sprintf(
'',
$data['name'],
$data['id'],
$data['value']
);
}
/**
* Constructs the HTML for numeric 'input' element.
*
* @access protected
* @param string $setting_name Setting key.
* @param int $p_in_min Minimum value.
* @param int $max Maximum value.
* @param bool $deci `true` if float, `false` if integer. Default `false`.
*
* @since 1.5.0
* @todo Refactor HTML generation.
*/
protected function add_num_box( string $setting_name, int $p_in_min, int $max, bool $deci = false ): string {
// Collect data for given settings field.
$data = $this->load_setting( $setting_name );
if ( $deci ) {
$value = number_format( floatval( $data['value'] ), 1 );
return sprintf(
'',
$data['name'],
$data['id'],
$value,
$p_in_min,
$max
);
}
return sprintf(
'',
$data['name'],
$data['id'],
$data['value'],
$p_in_min,
$max
);
}
/**
* Registers all Meta boxes for a sub-page.
*
* @access private
* @param string $parent_id Parent section unique ID.
*
* @since 1.5.0
*/
private function register_meta_boxes( string $parent_id ): void {
// Iterate through each meta box.
foreach ( $this->get_meta_boxes() as $meta_box ) {
if ( $parent_id !== $meta_box['parent'] ) {
continue;
}
add_meta_box(
$parent_id . '-' . $meta_box['id'],
$meta_box['title'],
array( $this, $meta_box['callback'] ),
$parent_id,
'main'
);
}
}
/**
* Append JavaScript and CSS files for specific sub-page.
*
* @access private
*
* @since 1.5.0
* @todo Move to {@see Admin}.
*/
private function append_scripts(): void {
wp_enqueue_script( 'postbox' );
wp_enqueue_style( 'wp-color-picker' );
wp_enqueue_script( 'wp-color-picker' );
}
// phpcs:enable WordPress.Security.NonceVerification.Recommended, WordPress.Security.NonceVerification.Missing
// phpcs:disable WordPress.Security.NonceVerification.Recommended, WordPress.Security.NonceVerification.Missing
/**
* Save all plugin settings.
*
* @access private
* @return bool `true` on save success, else `false`.
*
* @since 1.5.0
* @todo Review nonce verification.
*/
private function save_settings(): bool {
$new_settings = array();
$active_section_id = isset( $_GET['t'] ) ? wp_unslash( $_GET['t'] ) : array_key_first( $this->sections );
$active_section = $this->sections[ $active_section_id ];
foreach ( array_keys( $active_section->get_options() ) as $setting_key ) {
$new_settings[ $setting_key ] = array_key_exists( $setting_key, $_POST ) ? wp_unslash( $_POST[ $setting_key ] ) : '';
}
// Update settings.
return Settings::instance()->save_options( $active_section->get_options_group_slug(), $new_settings );
}
}