class-settings-addon.php
6 years ago
class-settings-advanced.php
5 years ago
class-settings-display.php
5 years ago
class-settings-email.php
6 years ago
class-settings-gateways.php
6 years ago
class-settings-general.php
5 years ago
class-settings-license.php
6 years ago
class-settings-advanced.php
354 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Give Settings Page/Tab |
| 4 | * |
| 5 | * @package Give |
| 6 | * @subpackage Classes/Give_Settings_Advanced |
| 7 | * @copyright Copyright (c) 2016, GiveWP |
| 8 | * @license http://opensource.org/licenses/gpl-2.0.php GNU Public License |
| 9 | * @since 1.8 |
| 10 | */ |
| 11 | |
| 12 | use Give\Onboarding\Setup\Page as SetupPage; |
| 13 | |
| 14 | if ( ! defined( 'ABSPATH' ) ) { |
| 15 | exit; // Exit if accessed directly |
| 16 | } |
| 17 | |
| 18 | if ( ! class_exists( 'Give_Settings_Advanced' ) ) : |
| 19 | |
| 20 | /** |
| 21 | * Give_Settings_Advanced. |
| 22 | * |
| 23 | * @sine 1.8 |
| 24 | */ |
| 25 | class Give_Settings_Advanced extends Give_Settings_Page { |
| 26 | |
| 27 | /** |
| 28 | * Constructor. |
| 29 | */ |
| 30 | public function __construct() { |
| 31 | $this->id = 'advanced'; |
| 32 | $this->label = __( 'Advanced', 'give' ); |
| 33 | |
| 34 | $this->default_tab = 'advanced-options'; |
| 35 | |
| 36 | if ( $this->id === give_get_current_setting_tab() ) { |
| 37 | add_action( |
| 38 | 'give_admin_field_remove_cache_button', |
| 39 | [ |
| 40 | $this, |
| 41 | 'render_remove_cache_button', |
| 42 | ], |
| 43 | 10, |
| 44 | 1 |
| 45 | ); |
| 46 | add_action( 'give_save_settings_give_settings', [ $this, 'validate_settngs' ] ); |
| 47 | } |
| 48 | |
| 49 | parent::__construct(); |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * Get settings array. |
| 54 | * |
| 55 | * @return array |
| 56 | * @since 1.8 |
| 57 | */ |
| 58 | public function get_settings() { |
| 59 | $settings = []; |
| 60 | |
| 61 | $current_section = give_get_current_setting_section(); |
| 62 | |
| 63 | switch ( $current_section ) { |
| 64 | case 'advanced-options': |
| 65 | $settings = [ |
| 66 | [ |
| 67 | 'id' => 'give_title_data_control_2', |
| 68 | 'type' => 'title', |
| 69 | ], |
| 70 | [ |
| 71 | 'name' => __( 'Default GiveWP Styles', 'give' ), |
| 72 | 'desc' => __( 'You can disable Give\'s default styles for donation forms and other frontend elements.', 'give' ), |
| 73 | 'id' => 'css', |
| 74 | 'type' => 'radio_inline', |
| 75 | 'default' => 'enabled', |
| 76 | 'options' => [ |
| 77 | 'enabled' => __( 'Enabled', 'give' ), |
| 78 | 'disabled' => __( 'Disabled', 'give' ), |
| 79 | ], |
| 80 | ], |
| 81 | [ |
| 82 | 'name' => __( 'Remove Data on Uninstall', 'give' ), |
| 83 | 'desc' => __( 'When the plugin is deleted, completely remove all GiveWP data. This includes all GiveWP settings, forms, form meta, donor, donor data, donations. Everything.', 'give' ), |
| 84 | 'id' => 'uninstall_on_delete', |
| 85 | 'type' => 'radio_inline', |
| 86 | 'default' => 'disabled', |
| 87 | 'options' => [ |
| 88 | 'enabled' => __( 'Yes, Remove all data', 'give' ), |
| 89 | 'disabled' => __( 'No, keep my GiveWP settings and donation data', 'give' ), |
| 90 | ], |
| 91 | ], |
| 92 | [ |
| 93 | 'name' => __( 'Default User Role', 'give' ), |
| 94 | 'desc' => __( 'Assign default user roles for donors when donors opt to register as a WP User.', 'give' ), |
| 95 | 'id' => 'donor_default_user_role', |
| 96 | 'type' => 'select', |
| 97 | 'default' => 'give_donor', |
| 98 | 'options' => give_get_user_roles(), |
| 99 | ], |
| 100 | [ |
| 101 | /* translators: %s: the_content */ |
| 102 | 'name' => sprintf( __( '%s filter', 'give' ), '<code>the_content</code>' ), |
| 103 | /* translators: 1: https://codex.wordpress.org/Plugin_API/Filter_Reference/the_content 2: the_content */ |
| 104 | 'desc' => sprintf( __( 'If you are seeing extra social buttons, related posts, or other unwanted elements appearing within your forms then you can disable WordPress\' content filter. <a href="%1$s" target="_blank">Learn more</a> about %2$s filter.', 'give' ), esc_url( 'https://codex.wordpress.org/Plugin_API/Filter_Reference/the_content' ), '<code>the_content</code>' ), |
| 105 | 'id' => 'the_content_filter', |
| 106 | 'default' => 'enabled', |
| 107 | 'type' => 'radio_inline', |
| 108 | 'options' => [ |
| 109 | 'enabled' => __( 'Enabled', 'give' ), |
| 110 | 'disabled' => __( 'Disabled', 'give' ), |
| 111 | ], |
| 112 | ], |
| 113 | [ |
| 114 | 'name' => __( 'Script Loading Location', 'give' ), |
| 115 | 'desc' => __( 'This allows you to load your GiveWP scripts either in the <code><head></code> or footer of your website.', 'give' ), |
| 116 | 'id' => 'scripts_footer', |
| 117 | 'type' => 'radio_inline', |
| 118 | 'default' => 'disabled', |
| 119 | 'options' => [ |
| 120 | 'disabled' => __( 'Head', 'give' ), |
| 121 | 'enabled' => __( 'Footer', 'give' ), |
| 122 | ], |
| 123 | ], |
| 124 | [ |
| 125 | 'name' => __( 'Babel Polyfill Script', 'give' ), |
| 126 | 'desc' => __( 'Decide whether to load the Babel polyfill, which provides backwards compatibility for older browsers such as IE 11. The polyfill may be disabled to avoid conflicts with other themes or plugins that load the same script.', 'give' ), |
| 127 | 'id' => 'babel_polyfill_script', |
| 128 | 'type' => 'radio_inline', |
| 129 | 'default' => 'enabled', |
| 130 | 'options' => [ |
| 131 | 'enabled' => __( 'Enabled', 'give' ), |
| 132 | 'disabled' => __( 'Disabled', 'give' ), |
| 133 | ], |
| 134 | ], |
| 135 | [ |
| 136 | 'name' => __( 'Setup Page', 'give' ), |
| 137 | /* translators: %s: about page URL */ |
| 138 | 'desc' => sprintf( |
| 139 | wp_kses( |
| 140 | __( 'Disable this option if you would like to disable the <a href="%s" target="_blank">GiveWP Setup page</a> that displays when GiveWP is first installed.', 'give' ), |
| 141 | [ |
| 142 | 'a' => [ |
| 143 | 'href' => [], |
| 144 | 'target' => [], |
| 145 | ], |
| 146 | ] |
| 147 | ), |
| 148 | esc_url( admin_url( 'edit.php?post_type=give_forms&page=give-setup' ) ) |
| 149 | ), |
| 150 | 'id' => 'setup_page_enabled', |
| 151 | 'type' => 'radio_inline', |
| 152 | 'default' => give_is_setting_enabled( |
| 153 | SetupPage::getSetupPageEnabledOrDisabled() |
| 154 | ) |
| 155 | ? SetupPage::ENABLED |
| 156 | : SetupPage::DISABLED, |
| 157 | 'options' => [ |
| 158 | SetupPage::ENABLED => __( 'Enabled', 'give' ), |
| 159 | SetupPage::DISABLED => __( 'Disabled', 'give' ), |
| 160 | ], |
| 161 | ], |
| 162 | [ |
| 163 | 'name' => __( 'Form Page URL Prefix', 'give' ), |
| 164 | 'desc' => sprintf( |
| 165 | __( 'This slug will be used as a base for the iframe URL that contains all form templates besides the legacy form template. Currently the iframe URLs look like %1$s. This options adds a rewrite rule that transforms the URL structure to a set of query vars. If you modify this URL prefix please ensure it is unique as it can cause a 404 error if a similar URL already exists.', 'give' ), |
| 166 | '<code>' . trailingslashit( home_url() ) . Give()->routeForm->getBase() . '/{form-slug}</code>' |
| 167 | ), |
| 168 | 'id' => Give()->routeForm->getOptionName(), |
| 169 | 'type' => 'text', |
| 170 | 'default' => Give()->routeForm->getBase(), |
| 171 | ], |
| 172 | [ |
| 173 | 'name' => 'GiveWP Cache', |
| 174 | 'id' => 'give-clear-cache', |
| 175 | 'buttonTitle' => __( 'Clear Cache', 'give' ), |
| 176 | 'desc' => __( 'Click this button if you want to clear Give\'s cache. The plugin stores common settings and queries in cache to optimize performance. Clearing cache will remove and begin rebuilding these saved queries.', 'give' ), |
| 177 | 'type' => 'remove_cache_button', |
| 178 | ], |
| 179 | [ |
| 180 | 'name' => __( 'Advanced Settings Docs Link', 'give' ), |
| 181 | 'id' => 'advanced_settings_docs_link', |
| 182 | 'url' => esc_url( 'http://docs.givewp.com/settings-advanced' ), |
| 183 | 'title' => __( 'Advanced Settings', 'give' ), |
| 184 | 'type' => 'give_docs_link', |
| 185 | ], |
| 186 | [ |
| 187 | 'id' => 'give_title_data_control_2', |
| 188 | 'type' => 'sectionend', |
| 189 | ], |
| 190 | ]; |
| 191 | break; |
| 192 | |
| 193 | case 'akismet-spam-protection': |
| 194 | $settings = [ |
| 195 | [ |
| 196 | 'id' => 'give_setting_advanced_section_akismet_spam_protection', |
| 197 | 'type' => 'title', |
| 198 | ], |
| 199 | [ |
| 200 | 'name' => __( 'Akismet SPAM Protection', 'give' ), |
| 201 | 'desc' => __( 'Add a layer of SPAM protection to your donation submissions with Akismet. When enabled, donation submissions will be first sent through Akismet\'s SPAM check API if you have the plugin activated and configured.', 'give' ), |
| 202 | 'id' => 'akismet_spam_protection', |
| 203 | 'type' => 'radio_inline', |
| 204 | 'default' => ( give_check_akismet_key() ) ? 'enabled' : 'disabled', |
| 205 | 'options' => [ |
| 206 | 'enabled' => __( 'Enabled', 'give' ), |
| 207 | 'disabled' => __( 'Disabled', 'give' ), |
| 208 | ], |
| 209 | ], |
| 210 | [ |
| 211 | 'name' => __( 'Whitelist by Email', 'give' ), |
| 212 | 'desc' => sprintf( |
| 213 | '%1$s %2$s', |
| 214 | __( 'Add emails one at a time to ensure that donations using that email bypass GiveWP\'s Akismet SPAM filtering. Emails added to the list here are always allowed to donate, even if they\'ve been flagged by Akismet.', 'give' ), |
| 215 | sprintf( |
| 216 | __( 'To permanently prevent emails from being flagged as SPAM by Akismet <a href="%1$s" target="_blank">contact their team here</a>.', 'give' ), |
| 217 | esc_url( 'https://akismet.com/contact/' ) |
| 218 | ) |
| 219 | ), |
| 220 | 'id' => 'akismet_whitelisted_email_addresses', |
| 221 | 'type' => 'email', |
| 222 | 'attributes' => [ |
| 223 | 'placeholder' => 'jon@email.com', |
| 224 | ], |
| 225 | 'repeat' => true, |
| 226 | 'repeat_btn_title' => esc_html__( 'Add Email', 'give' ), |
| 227 | ], |
| 228 | [ |
| 229 | 'id' => 'give_setting_advanced_section_akismet_spam_protection', |
| 230 | 'type' => 'sectionend', |
| 231 | ], |
| 232 | ]; |
| 233 | break; |
| 234 | } |
| 235 | |
| 236 | /** |
| 237 | * Hide caching setting by default. |
| 238 | * |
| 239 | * @since 2.0 |
| 240 | */ |
| 241 | if ( apply_filters( 'give_settings_advanced_show_cache_setting', false ) ) { |
| 242 | array_splice( |
| 243 | $settings, |
| 244 | 1, |
| 245 | 0, |
| 246 | [ |
| 247 | [ |
| 248 | 'name' => __( 'Cache', 'give' ), |
| 249 | 'desc' => __( 'If caching is enabled the plugin will start caching custom post type related queries and reduce the overall load time.', 'give' ), |
| 250 | 'id' => 'cache', |
| 251 | 'type' => 'radio_inline', |
| 252 | 'default' => 'enabled', |
| 253 | 'options' => [ |
| 254 | 'enabled' => __( 'Enabled', 'give' ), |
| 255 | 'disabled' => __( 'Disabled', 'give' ), |
| 256 | ], |
| 257 | ], |
| 258 | ] |
| 259 | ); |
| 260 | } |
| 261 | |
| 262 | /** |
| 263 | * Filter the advanced settings. |
| 264 | * Backward compatibility: Please do not use this filter. This filter is deprecated in 1.8 |
| 265 | */ |
| 266 | $settings = apply_filters( 'give_settings_advanced', $settings ); |
| 267 | |
| 268 | /** |
| 269 | * Filter the settings. |
| 270 | * |
| 271 | * @param array $settings |
| 272 | * |
| 273 | * @since 1.8 |
| 274 | */ |
| 275 | $settings = apply_filters( 'give_get_settings_' . $this->id, $settings ); |
| 276 | |
| 277 | // Output. |
| 278 | return $settings; |
| 279 | } |
| 280 | |
| 281 | /** |
| 282 | * Get sections. |
| 283 | * |
| 284 | * @return array |
| 285 | * @since 1.8 |
| 286 | */ |
| 287 | public function get_sections() { |
| 288 | $sections = [ |
| 289 | 'advanced-options' => __( 'Advanced Options', 'give' ), |
| 290 | 'akismet-spam-protection' => __( 'Akismet SPAM Protection', 'give' ), |
| 291 | ]; |
| 292 | |
| 293 | return apply_filters( 'give_get_sections_' . $this->id, $sections ); |
| 294 | } |
| 295 | |
| 296 | |
| 297 | /** |
| 298 | * Render remove_cache_button field type |
| 299 | * |
| 300 | * @param array $field |
| 301 | * |
| 302 | * @since 2.1 |
| 303 | * @access public |
| 304 | */ |
| 305 | public function render_remove_cache_button( $field ) { |
| 306 | ?> |
| 307 | <tr valign="top" <?php echo ! empty( $field['wrapper_class'] ) ? 'class="' . $field['wrapper_class'] . '"' : ''; ?>> |
| 308 | <th scope="row" class="titledesc"> |
| 309 | <label |
| 310 | for="<?php echo esc_attr( $field['id'] ); ?>"><?php echo esc_html( $field['name'] ); ?></label> |
| 311 | </th> |
| 312 | <td class="give-forminp"> |
| 313 | <button type="button" id="<?php echo esc_attr( $field['id'] ); ?>" |
| 314 | class="button button-secondary"><?php echo esc_html( $field['buttonTitle'] ); ?></button> |
| 315 | <?php echo Give_Admin_Settings::get_field_description( $field ); ?> |
| 316 | </td> |
| 317 | </tr> |
| 318 | <?php |
| 319 | } |
| 320 | |
| 321 | |
| 322 | /** |
| 323 | * Validate setting |
| 324 | * |
| 325 | * @param array $options |
| 326 | * |
| 327 | * @since 2.2.0 |
| 328 | * @access public |
| 329 | */ |
| 330 | public function validate_settngs( $options ) { |
| 331 | // Sanitize data. |
| 332 | $akismet_spam_protection = isset( $options['akismet_spam_protection'] ) |
| 333 | ? $options['akismet_spam_protection'] |
| 334 | : ( give_check_akismet_key() ? 'enabled' : 'disabled' ); |
| 335 | |
| 336 | // Show error message if Akismet not configured and Admin try to save 'enabled' option. |
| 337 | if ( |
| 338 | give_is_setting_enabled( $akismet_spam_protection ) |
| 339 | && ! give_check_akismet_key() |
| 340 | ) { |
| 341 | Give_Admin_Settings::add_error( |
| 342 | 'give-akismet-protection', |
| 343 | __( 'Please properly configure Akismet to enable SPAM protection.', 'give' ) |
| 344 | ); |
| 345 | |
| 346 | give_update_option( 'akismet_spam_protection', 'disabled' ); |
| 347 | } |
| 348 | } |
| 349 | } |
| 350 | |
| 351 | endif; |
| 352 | |
| 353 | return new Give_Settings_Advanced(); |
| 354 |