settings_sections = $sections; return $this; } /** * Add a single section * * @param array $section */ function add_section($section) { $this->settings_sections[] = $section; return $this; } /** * Set settings fields * * @param array $fields settings fields array */ function set_fields($fields) { $this->settings_fields = $fields; return $this; } function add_field($section, $field) { $defaults = array( 'name' => '', 'label' => '', 'desc' => '', 'type' => 'text' ); $arg = wp_parse_args($field, $defaults); $this->settings_fields[$section][] = $arg; return $this; } function do_settings_sections($page) { global $wp_settings_sections, $wp_settings_fields; if (!isset($wp_settings_sections[$page])) { return; } // $matched_height = ' bdt-grid bdt-height-match="target: > div > .upk-option-item-inner"'; $data_settings = ''; foreach ((array) $wp_settings_sections[$page] as $section) { if ($section['id'] == 'ultimate_post_kit_api_settings') { $section_class = ' bdt-grid-small bdt-child-width-1-3@xl'; } elseif ($section['id'] == 'ultimate_post_kit_other_settings') { // $data_settings = $matched_height; $section_class = ' bdt-grid-small bdt-child-width-1-3@xl'; } else { $section_class = ' bdt-grid-small bdt-child-width-1-4@xl'; } if ($section['callback']) { call_user_func($section['callback'], $section); } if (!isset($wp_settings_fields) || !isset($wp_settings_fields[$page]) || !isset($wp_settings_fields[$page][$section['id']])) { continue; } echo '

'; echo '

'.esc_html__('Ops! Your Searched widget not found! Do you have any idea? If yes, ', 'ultimate-post-kit').''.esc_html__('Submit here', 'ultimate-post-kit').'

'; $this->do_settings_fields($page, $section['id']); echo '

'; } } function do_settings_fields($page, $section) { global $wp_settings_fields; if (!isset($wp_settings_fields[$page][$section])) { return; } foreach ((array) $wp_settings_fields[$page][$section] as $field) { $class = ''; if (!empty($field['args']['class'])) { $class .= ' ' . esc_attr($field['args']['class']); } if (!empty($field['args']['widget_type'])) { $class .= ' upk-widget-' . esc_attr($field['args']['widget_type']); } if (!empty($field['args']['widget_type']) && 'pro' == $field['args']['widget_type'] && true !== upk_license_validation()) { $class .= ' upk-pro-inactive'; } $used_widgets = self::get_used_widgets_obj(); $widget_name = 'upk-' . str_replace(' ', '-', strtolower($field['args']['id'])); $used_widgets_count = 0; if (isset($used_widgets)) { $used_widgets_count = (in_array($widget_name, array_keys($used_widgets)) ? $used_widgets[$widget_name] : 0); if ($used_widgets_count === 0) { $widget_name = str_replace('_', '-', $widget_name); $used_widgets_count = (in_array($widget_name, array_keys($used_widgets)) ? $used_widgets[$widget_name] : 0); } } $widget_used_status = ' upk-used'; if ($used_widgets_count === 0) { $widget_used_status = ' upk-unused'; } $data_type = ' data-widget-type="' . esc_attr($field['args']['widget_type']) . '" data-content-type="' . esc_attr($field['args']['content_type']) . esc_attr($widget_used_status) . '" data-widget-name="' . strtolower($field['args']['name']) . '"'; if (!empty($field['args']['widget_type']) && 'pro' == $field['args']['widget_type'] && true !== _is_upk_pro_activated()) { $data_type .= ' bdt-tooltip="'.esc_html__('Pro widget only works with Pro version.', 'ultimate-post-kit').'"'; } echo wp_kses("

", $this->get_allowed_field_html()); call_user_func($field['callback'], $field['args']); echo '

'; } } /** * Initialize and registers the settings sections and fileds to WordPress * * Usually this should be called at `admin_init` hook. * * This function gets the initiated settings sections and fields. Then * registers them to WordPress and ready for use. */ function admin_init() { //register settings sections foreach ($this->settings_sections as $section) { if (false == get_option($section['id'])) { add_option($section['id']); } if (isset($section['desc']) && !empty($section['desc'])) { $section['desc'] = '

' . $section['desc'] . '

'; $callback = function () use ($section) { echo wp_kses_post($section['desc']); }; } else if (isset($section['callback'])) { $callback = $section['callback']; } else { $callback = null; } add_settings_section($section['id'], $section['title'], $callback, $section['id']); } //register settings fields foreach ($this->settings_fields as $section => $field) { foreach ($field as $option) { $name = $option['name']; $type = isset($option['type']) ? $option['type'] : 'text'; $label = isset($option['label']) ? $option['label'] : ''; $callback = isset($option['callback']) ? $option['callback'] : array($this, 'callback_' . $type); $args = array( 'id' => $name, 'class' => isset($option['class']) ? 'upk-' . $name . ' ' . $option['class'] : 'upk-' . $name, 'label_for' => "upk-{$section}[{$name}]", 'desc' => isset($option['desc']) ? $option['desc'] : '', 'name' => $label, 'section' => $section, 'size' => isset($option['size']) ? $option['size'] : null, 'options' => isset($option['options']) ? $option['options'] : '', 'std' => isset($option['default']) ? $option['default'] : '', 'sanitize_callback' => isset($option['sanitize_callback']) ? $option['sanitize_callback'] : '', 'type' => $type, 'placeholder' => isset($option['placeholder']) ? $option['placeholder'] : '', 'min' => isset($option['min']) ? $option['min'] : '', 'max' => isset($option['max']) ? $option['max'] : '', 'step' => isset($option['step']) ? $option['step'] : '', 'plugin_name' => !empty($option['plugin_name']) ? $option['plugin_name'] : null, 'plugin_path' => !empty($option['plugin_path']) ? $option['plugin_path'] : null, 'paid' => !empty($option['paid']) ? $option['paid'] : null, 'widget_type' => !empty($option['widget_type']) ? $option['widget_type'] : null, 'content_type' => !empty($option['content_type']) ? $option['content_type'] : null, 'demo_url' => !empty($option['demo_url']) ? $option['demo_url'] : null, 'video_url' => !empty($option['video_url']) ? $option['video_url'] : null, ); add_settings_field("{$section}[{$name}]", $label, $callback, $section, $section, $args); } } // creates our settings in the options table foreach ($this->settings_sections as $section) { register_setting( $section['id'], $section['id'], array( 'type' => 'array', 'sanitize_callback' => array($this, 'sanitize_options'), ) ); } } /** * Get field description for display * * @param array $args settings field args */ public function get_field_description($args) { if (!empty($args['desc'])) { $desc = sprintf('

%s

', $args['desc']); } else { $desc = ''; } return $desc; } /** * Allowed HTML for settings-field output. Covers every form control this * class renders so field markup survives wp_kses() intact. * * @return array */ public function get_allowed_field_html() { $attr = array( 'class' => array(), 'id' => array(), 'name' => array(), 'value' => array(), 'type' => array(), 'checked' => array(), 'selected' => array(), 'multiple' => array(), 'disabled' => array(), 'readonly' => array(), 'placeholder' => array(), 'min' => array(), 'max' => array(), 'step' => array(), 'rows' => array(), 'cols' => array(), 'for' => array(), 'scope' => array(), 'style' => array(), 'title' => array(), 'target' => array(), 'href' => array(), 'src' => array(), 'rel' => array(), 'aria-hidden' => array(), 'bdt-tooltip' => array(), 'bdt-grid' => array(), 'data-default-color' => array(), 'data-type' => array(), 'data-widget-type' => array(), 'data-content-type' => array(), 'data-widget-name' => array(), ); return array( 'div' => $attr, 'span' => $attr, 'label' => $attr, 'input' => $attr, 'select' => $attr, 'option' => $attr, 'textarea' => $attr, 'fieldset' => $attr, 'a' => $attr, 'i' => $attr, 'p' => $attr, 'h3' => $attr, 'hr' => $attr, 'br' => array(), 'strong' => array(), 'em' => array(), ); } /** * Displays a text field for a settings field * * @param array $args settings field args */ function callback_text($args) { $value = esc_attr($this->get_option($args['id'], $args['section'], $args['std'])); $class = 'bdt-input'; $type = isset($args['type']) ? $args['type'] : 'text'; $placeholder = empty($args['placeholder']) ? '' : ' placeholder="' . $args['placeholder'] . '"'; $html = ''; $html .= '

'; if ($args['video_url']) { $html .= ''; } $html .= sprintf('', $args['section'], $args['id']); $html .= '' . $args['name'] . ''; $html .= ''; $html .= sprintf('', $type, $class, $args['section'], $args['id'], $value, $placeholder); $html .= $this->get_field_description($args); $html .= '

'; echo wp_kses($html, $this->get_allowed_field_html()); } /** * Displays a url field for a settings field * * @param array $args settings field args */ function callback_url($args) { $this->callback_text($args); } /** * Displays a number field for a settings field * * @param array $args settings field args */ function callback_number($args) { $value = esc_attr($this->get_option($args['id'], $args['section'], $args['std'])); $size = isset($args['size']) && !is_null($args['size']) ? $args['size'] : 'regular'; $type = isset($args['type']) ? $args['type'] : 'number'; $placeholder = empty($args['placeholder']) ? '' : ' placeholder="' . $args['placeholder'] . '"'; $min = ($args['min'] == '') ? '' : ' min="' . $args['min'] . '"'; $max = ($args['max'] == '') ? '' : ' max="' . $args['max'] . '"'; $step = ($args['step'] == '') ? '' : ' step="' . $args['step'] . '"'; $html = sprintf('', $type, $size, $args['section'], $args['id'], $value, $placeholder, $min, $max, $step); $html .= $this->get_field_description($args); echo wp_kses($html, $this->get_allowed_field_html()); } /** * Get used widgets. * * @access public * @since 6.0.0 * * @return array */ public static function get_used_widgets_obj() { return UltimatePostKit_Admin_Settings::get_used_widgets(); } /** * Get unused widgets. * * @access public * @since 6.0.0 * * @return array */ public static function get_unused_widgets_obj() { return UltimatePostKit_Admin_Settings::get_unused_widgets(); } /** * Displays a checkbox for a settings field * * @param array $args settings field args */ function callback_checkbox($args) { $value = esc_attr($this->get_option($args['id'], $args['section'], $args['std'])); $plugin_name = isset($args['plugin_name']) ? $args['plugin_name'] : ''; $plugin_path = isset($args['plugin_path']) ? $args['plugin_path'] : ''; $paid = isset($args['paid']) ? $args['paid'] : ''; $parent_class = isset($args['ep_parent_switcher']) ? ' upk-feature-option-parent' : ''; $used_widgets = self::get_used_widgets_obj(); $widget_name = 'bdt-' . $args['id']; $used_widgets_count = 0; if (isset($used_widgets)) { $used_widgets_count = (in_array($widget_name, array_keys($used_widgets)) ? $used_widgets[$widget_name] : 0); if ($used_widgets_count === 0) { $widget_name = str_replace('_', '-', $widget_name); $used_widgets_count = (in_array($widget_name, array_keys($used_widgets)) ? $used_widgets[$widget_name] : 0); } } $html = ''; $html .= '

'; $html .= '

'; $html .= '

'; $html .= ''; $html .= '

'; $html .= sprintf('', $args['section'], $args['id']); $html .= '' . $args['name'] . ''; $html .= ''; $html .= '

'; if ($args['demo_url']) { /* translators: %s: widget name */ $demo_title = sprintf(esc_html__('View %s Widget Demo', 'ultimate-post-kit'), $args['name']); $html .= '' . esc_html__('Demo', 'ultimate-post-kit') . ''; } if ($args['video_url']) { $html .= 'Video'; } $html .= '

'; $html .= '

'; $html .= '

'; $html .= '

'; // 3rd party widgets if ($plugin_name and $plugin_path) { if ($this->_is_plugin_installed($plugin_name, $plugin_path)) { if (!current_user_can('activate_plugins')) { return; } if (!is_plugin_active($plugin_path)) { $active_link = wp_nonce_url('plugins.php?action=activate&plugin=' . $plugin_path . '&plugin_status=all&paged=1&s', 'activate-plugin_' . $plugin_path); $html .= ''; } } else { if ($paid) { $html .= ''; } else { $install_link = wp_nonce_url(self_admin_url('update.php?action=install-plugin&plugin=' . $plugin_name), 'install-plugin_' . $plugin_name); $html .= ''; } } if ($this->_is_plugin_installed($plugin_name, $plugin_path) and is_plugin_active($plugin_path)) { $html .= '

'; $html .= sprintf('', $args['section'], $args['id']); $html .= sprintf('', $args['section'], $args['id']); $html .= sprintf('', $args['section'], $args['id'], checked($value, 'on', false)); $html .= ''; $html .= ''; $html .= '

'; } } else { // core widgets $html .= '

'; $html .= sprintf('', $args['section'], $args['id']); $html .= sprintf('', $args['section'], $args['id']); $html .= sprintf('', $args['section'], $args['id'], checked($value, 'on', false)); $html .= ''; $html .= ''; $html .= '

'; } $html .= '

'; $html .= '

'; $html .= '

'; echo wp_kses($html, array( 'div' => array( 'class' => array(), ), 'span' => array( 'class' => array(), ), 'label' => array( 'for' => array(), ), 'input' => array( 'type' => array(), 'class' => array(), 'id' => array(), 'name' => array(), 'value' => array(), 'checked' => array(), ), 'i' => array( 'class' => array(), 'aria-hidden' => array(), ), 'a' => array( 'href' => array(), 'target' => array(), 'class' => array(), 'bdt-tooltip' => array(), ), 'fieldset' => array(), )); } function _is_plugin_installed($plugin, $plugin_path) { $installed_plugins = get_plugins(); return isset($installed_plugins[$plugin_path]); } /** * Displays a multicheckbox for a settings field * * @param array $args settings field args */ function callback_multicheck($args) { $value = $this->get_option($args['id'], $args['section'], $args['std']); $html = '

'; $html .= sprintf('', $args['section'], $args['id']); foreach ($args['options'] as $key => $label) { $checked = isset($value[$key]) ? $value[$key] : '0'; $html .= sprintf('', $args['section'], $args['id'], $key); $html .= sprintf('', $args['section'], $args['id'], $key, checked($checked, $key, false)); $html .= ''; $html .= sprintf('%1$s
', $label); } $html .= $this->get_field_description($args); $html .= '

'; echo wp_kses($html, $this->get_allowed_field_html()); } /** * Displays a radio button for a settings field * * @param array $args settings field args */ function callback_radio($args) { $value = $this->get_option($args['id'], $args['section'], $args['std']); $html = '

'; foreach ($args['options'] as $key => $label) { $html .= sprintf('', $args['section'], $args['id'], $key); $html .= sprintf('', $args['section'], $args['id'], $key, checked($value, $key, false)); $html .= sprintf('%1$s
', $label); } $html .= $this->get_field_description($args); $html .= '

'; echo wp_kses($html, $this->get_allowed_field_html()); } /** * Displays a selectbox for a settings field * * @param array $args settings field args */ function callback_select($args) { $value = esc_attr($this->get_option($args['id'], $args['section'], $args['std'])); $size = isset($args['size']) && !is_null($args['size']) ? $args['size'] : 'regular'; $html = sprintf(''); $html .= $this->get_field_description($args); echo wp_kses($html, $this->get_allowed_field_html()); } /** * Displays a textarea for a settings field * * @param array $args settings field args */ function callback_textarea($args) { $value = esc_textarea($this->get_option($args['id'], $args['section'], $args['std'])); $size = isset($args['size']) && !is_null($args['size']) ? $args['size'] : 'regular'; $placeholder = empty($args['placeholder']) ? '' : ' placeholder="' . $args['placeholder'] . '"'; $html = ''; $html .= sprintf('', $args['section'], $args['id']); $html .= '' . $args['name'] . ''; $html .= ''; $html .= sprintf('', $size, $args['section'], $args['id'], $placeholder, $value); $html .= $this->get_field_description($args); echo wp_kses($html, $this->get_allowed_field_html()); } /** * Displays the html for a settings field * * @param array $args settings field args * @return string */ function callback_html($args) { echo wp_kses($args['desc'], $this->get_allowed_field_html()); } /** * Displays a file upload field for a settings field * * @param array $args settings field args */ function callback_file($args) { $value = esc_attr($this->get_option($args['id'], $args['section'], $args['std'])); $size = isset($args['size']) && !is_null($args['size']) ? $args['size'] : 'regular'; $id = $args['section'] . '[' . $args['id'] . ']'; $label = isset($args['options']['button_label']) ? $args['options']['button_label'] : __('Choose File', 'ultimate-post-kit'); $html = sprintf('', $size, $args['section'], $args['id'], $value); $html .= ''; $html .= $this->get_field_description($args); echo wp_kses($html, $this->get_allowed_field_html()); } /** * Displays a password field for a settings field * * @param array $args settings field args */ function callback_password($args) { $value = esc_attr($this->get_option($args['id'], $args['section'], $args['std'])); $size = isset($args['size']) && !is_null($args['size']) ? $args['size'] : 'regular'; $html = sprintf('', $size, $args['section'], $args['id'], $value); $html .= $this->get_field_description($args); echo wp_kses($html, $this->get_allowed_field_html()); } /** * Displays a color picker field for a settings field * * @param array $args settings field args */ function callback_color($args) { $value = esc_attr($this->get_option($args['id'], $args['section'], $args['std'])); $size = isset($args['size']) && !is_null($args['size']) ? $args['size'] : 'regular'; $html = sprintf('', $size, $args['section'], $args['id'], $value, $args['std']); $html .= $this->get_field_description($args); echo wp_kses($html, $this->get_allowed_field_html()); } /** * Displays a 2 colspan subheading field for a settings field * * @param array $args settings field args */ function callback_subheading($args) { $html = '

' . $args['name'] . '

'; $html .= $this->get_field_description($args); $html .= '

'; echo wp_kses($html, $this->get_allowed_field_html()); } function callback_start_group($args) { $html = '

'; $html .= sprintf('', $args['section'], $args['id']); $html .= '' . $args['name'] . ''; $html .= ''; if ($args['video_url']) { $html .= ''; } $html .= $this->get_field_description($args); $html .= '

'; echo wp_kses($html, $this->get_allowed_field_html()); } function callback_end_group($args) { $html = '

'; $html .= '

'; echo wp_kses($html, $this->get_allowed_field_html()); } /** * Displays a 2 colspan separator field for a settings field * * @param array $args settings field args */ function callback_separator($args) { $html = '

'; $html .= $this->get_field_description($args); echo wp_kses($html, $this->get_allowed_field_html()); } /** * Displays a select box for creating the pages select box * * @param array $args settings field args */ function callback_pages($args) { $dropdown_args = array( 'selected' => esc_attr($this->get_option($args['id'], $args['section'], $args['std'])), 'name' => $args['section'] . '[' . $args['id'] . ']', 'id' => $args['section'] . '[' . $args['id'] . ']', 'echo' => 0 ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- 'echo' => 0 makes wp_dropdown_pages() return (not print) the markup, which is escaped via wp_kses() below. $html = wp_dropdown_pages($dropdown_args); echo wp_kses($html, $this->get_allowed_field_html()); } /** * Sanitize callback for Settings API * * @return mixed */ function sanitize_options($options) { if (!$options) { return $options; } foreach ($options as $option_slug => $option_value) { $sanitize_callback = $this->get_sanitize_callback($option_slug); // If a field-specific callback is set, use it. if ($sanitize_callback) { $options[$option_slug] = call_user_func($sanitize_callback, $option_value); continue; } // Otherwise never store the value raw — apply a safe default so no // submitted field escapes sanitization (wp.org register_setting rule). $options[$option_slug] = $this->sanitize_default($option_value); } return $options; } /** * Default sanitizer for settings values without a field-specific callback. * * @param mixed $value Raw value. * @return mixed */ private function sanitize_default($value) { if (is_array($value)) { return array_map(array($this, 'sanitize_default'), $value); } return is_scalar($value) ? sanitize_text_field((string) $value) : ''; } /** * Get sanitization callback for given option slug * * @param string $slug option slug * * @return mixed string or bool false */ function get_sanitize_callback($slug = '') { if (empty($slug)) { return false; } // Iterate over registered fields and see if we can find proper callback foreach ($this->settings_fields as $section => $options) { foreach ($options as $option) { if ($option['name'] != $slug) { continue; } // Return the callback name return isset($option['sanitize_callback']) && is_callable($option['sanitize_callback']) ? $option['sanitize_callback'] : false; } } return false; } /** * Get the value of a settings field * * @param string $option settings field name * @param string $section the section name this field belongs to * @param string $default default text if it's not found * @return string */ function get_option($option, $section, $default = '') { $options = get_option($section); if (isset($options[$option])) { return $options[$option]; } return $default; } /** * Show navigations as tab * * Shows all the settings section labels as tab */ function show_navigation() { $html = '

'; $html .= '

%2$s
%3$s
%3$s
%3$s

'; $html .= '

'; echo wp_kses($html, array( 'div' => array( 'class' => true, ), 'ul' => array( 'class' => true, 'bdt-tab' => true, ), 'li' => array( 'class' => true, ), 'a' => array( 'href' => true, 'class' => true, 'id' => true, 'data-tab-index' => true, ), 'i' => array( 'class' => true, ) )); } /** * Extra dashboard tabs contributed by add-on plugins. * * Neutral extension point: the core plugin renders whatever tabs an add-on * registers here and ships none of its own. Each item is an array * [ 'id' => string, 'title' => string, 'icon' => string, 'callback' => * callable ] where the callback echoes the tab body. * * @return array */ public function get_extra_dashboard_tabs() { return (array) apply_filters( 'ultimate_post_kit_dashboard_extra_tabs', array() ); } function ultimate_post_kit_settings_save() { if (!check_ajax_referer('ultimate-post-kit-settings-save-nonce')) { wp_send_json_error(); } if (!current_user_can('manage_options')) { return; } $moudle_id = isset($_POST['id']) ? sanitize_text_field(wp_unslash($_POST['id'])) : ''; unset($_POST['id']); // Only ever write options inside this plugin's own namespace. Without // this the option name was fully attacker-chosen, letting a request // overwrite arbitrary core options (default_role, siteurl, ...). if ('' === $moudle_id || 0 !== strpos($moudle_id, 'ultimate_post_kit')) { wp_send_json_error(); } if (isset($_POST[$moudle_id])) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- sanitized below via sanitize_options()/sanitize_default(). $raw_value = wp_unslash($_POST[$moudle_id]); // Route the value through the registered per-field sanitizers // instead of storing raw request data. $value = is_array($raw_value) ? $this->sanitize_options($raw_value) : sanitize_text_field($raw_value); update_option($moudle_id, $value); } wp_send_json_success(); } /** * Get all sections including manually created content pages */ private function get_all_sections() { // Start with the settings sections that have forms $all_sections = $this->settings_sections; // Add manually created content sections that don't have settings forms $content_only_sections = [ [ 'id' => 'ultimate_post_kit_analytics_system_req', 'title' => esc_html__('System Status', 'ultimate-post-kit'), 'icon' => 'dashicons dashicons-chart-bar', ], [ 'id' => 'ultimate_post_kit_other_plugins', 'title' => esc_html__('Other Plugins', 'ultimate-post-kit'), 'icon' => 'dashicons dashicons-admin-plugins', ], // [ // 'id' => 'ultimate_post_kit_affiliate', // 'title' => esc_html__('Get Up to 60%', 'ultimate-post-kit'), // 'icon' => 'dashicons dashicons-money-alt', // ], ]; if (true == _is_upk_pro_activated()) { $content_only_sections[] = [ 'id' => 'ultimate_post_kit_rollback_version', 'title' => esc_html__('Rollback Version', 'ultimate-post-kit'), 'icon' => 'dashicons dashicons-update', ]; } // Check if each content section exists in settings sections, if not add it foreach ($content_only_sections as $content_section) { $exists = false; foreach ($all_sections as $existing_section) { if ($existing_section['id'] === $content_section['id']) { $exists = true; break; } } if (!$exists) { $all_sections[] = $content_section; } } return $all_sections; } /** * Show the section settings forms * * This function displays every sections in a different form */ function show_forms() { ?> settings_sections as $form) { $i++; ?>