class-settings-addon.php
6 years ago
class-settings-advanced.php
4 years ago
class-settings-display.php
4 years ago
class-settings-email.php
6 years ago
class-settings-gateways.php
4 years ago
class-settings-general.php
5 years ago
class-settings-license.php
6 years ago
class-settings-recurring.php
4 years ago
class-settings-advanced.php
355 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' => __( 'This controls GiveWP\'s default styles for legacy donation forms and other front end elements. Disabling this option means that you\'ll need to supply your own styles.', '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' => __( 'Users are given this user role when they opt into creating a WordPress/site account along with their donation.', '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( __( 'This controls whether or not GiveWP legacy form content is treated like WordPress content. Disabling this option means that things like social sharing and other theme- or plugin-added functionality to enhance or append things to content will not be applied to GiveWP legacy form content. <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' => __( 'Setup Page', 'give' ), |
| 126 | /* translators: %s: about page URL */ |
| 127 | 'desc' => sprintf( |
| 128 | wp_kses( |
| 129 | __( 'This option controls the display of the <a href="%s" target="_blank">GiveWP Setup page</a> when GiveWP is first installed.', 'give' ), |
| 130 | [ |
| 131 | 'a' => [ |
| 132 | 'href' => [], |
| 133 | 'target' => [], |
| 134 | ], |
| 135 | ] |
| 136 | ), |
| 137 | esc_url( admin_url( 'edit.php?post_type=give_forms&page=give-setup' ) ) |
| 138 | ), |
| 139 | 'id' => 'setup_page_enabled', |
| 140 | 'type' => 'radio_inline', |
| 141 | 'default' => give_is_setting_enabled( |
| 142 | SetupPage::getSetupPageEnabledOrDisabled() |
| 143 | ) |
| 144 | ? SetupPage::ENABLED |
| 145 | : SetupPage::DISABLED, |
| 146 | 'options' => [ |
| 147 | SetupPage::ENABLED => __( 'Enabled', 'give' ), |
| 148 | SetupPage::DISABLED => __( 'Disabled', 'give' ), |
| 149 | ], |
| 150 | 'wrapper_class' => version_compare( get_bloginfo( 'version' ), '5.0', '<=' ) ? 'give-hidden' : null, |
| 151 | ], |
| 152 | [ |
| 153 | 'name' => __( 'Form Page URL Prefix', 'give' ), |
| 154 | 'desc' => sprintf( |
| 155 | __( 'This slug is used as a base for the (invisible to users/site visitors) iframe URL that contains all form templates besides the legacy form template. The URL currently looks like this: %1$s. This option allows you to modify that URL to avoid conflicts that might exist with other pages and URLs on the site.', 'give' ), |
| 156 | '<code>' . trailingslashit( home_url() ) . Give()->routeForm->getBase() . '/{form-slug}</code>' |
| 157 | ), |
| 158 | 'id' => Give()->routeForm->getOptionName(), |
| 159 | 'type' => 'text', |
| 160 | 'default' => Give()->routeForm->getBase(), |
| 161 | ], |
| 162 | [ |
| 163 | 'name' => __( 'Advanced Database Updates', 'give' ), |
| 164 | 'desc' => __( 'This option is only for advanced users and/or those directed by GiveWP support. Once you enable this, you\'ll have the ability to override the run order and to force re-running for database updates at Donations > Tools > Data. If you don\'t know what you are doing, you can easily break things with this option enabled. Do not leave this option enabled after you\'re done troubleshooting.', 'give' ), |
| 165 | 'id' => 'enable_database_updates', |
| 166 | 'type' => 'radio_inline', |
| 167 | 'default' => 'disabled', |
| 168 | 'options' => [ |
| 169 | 'enabled' => __( 'Enabled', 'give' ), |
| 170 | 'disabled' => __( 'Disabled', 'give' ), |
| 171 | ], |
| 172 | ], |
| 173 | [ |
| 174 | 'name' => 'GiveWP Cache', |
| 175 | 'id' => 'give-clear-cache', |
| 176 | 'buttonTitle' => __( 'Clear Cache', 'give' ), |
| 177 | 'desc' => __( 'Click this button if you want to clear GiveWP\'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' ), |
| 178 | 'type' => 'remove_cache_button', |
| 179 | ], |
| 180 | [ |
| 181 | 'name' => __( 'Advanced Settings Docs Link', 'give' ), |
| 182 | 'id' => 'advanced_settings_docs_link', |
| 183 | 'url' => esc_url( 'http://docs.givewp.com/settings-advanced' ), |
| 184 | 'title' => __( 'Advanced Settings', 'give' ), |
| 185 | 'type' => 'give_docs_link', |
| 186 | ], |
| 187 | [ |
| 188 | 'id' => 'give_title_data_control_2', |
| 189 | 'type' => 'sectionend', |
| 190 | ], |
| 191 | ]; |
| 192 | break; |
| 193 | |
| 194 | case 'akismet-spam-protection': |
| 195 | $settings = [ |
| 196 | [ |
| 197 | 'id' => 'give_setting_advanced_section_akismet_spam_protection', |
| 198 | 'type' => 'title', |
| 199 | ], |
| 200 | [ |
| 201 | 'name' => __( 'Akismet SPAM Protection', 'give' ), |
| 202 | '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' ), |
| 203 | 'id' => 'akismet_spam_protection', |
| 204 | 'type' => 'radio_inline', |
| 205 | 'default' => ( give_check_akismet_key() ) ? 'enabled' : 'disabled', |
| 206 | 'options' => [ |
| 207 | 'enabled' => __( 'Enabled', 'give' ), |
| 208 | 'disabled' => __( 'Disabled', 'give' ), |
| 209 | ], |
| 210 | ], |
| 211 | [ |
| 212 | 'name' => __( 'Whitelist by Email', 'give' ), |
| 213 | 'desc' => sprintf( |
| 214 | '%1$s %2$s', |
| 215 | __( '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' ), |
| 216 | sprintf( |
| 217 | __( 'To permanently prevent emails from being flagged as SPAM by Akismet <a href="%1$s" target="_blank">contact their team here</a>.', 'give' ), |
| 218 | esc_url( 'https://akismet.com/contact/' ) |
| 219 | ) |
| 220 | ), |
| 221 | 'id' => 'akismet_whitelisted_email_addresses', |
| 222 | 'type' => 'email', |
| 223 | 'attributes' => [ |
| 224 | 'placeholder' => 'test@example.com', |
| 225 | ], |
| 226 | 'repeat' => true, |
| 227 | 'repeat_btn_title' => esc_html__( 'Add Email', 'give' ), |
| 228 | ], |
| 229 | [ |
| 230 | 'id' => 'give_setting_advanced_section_akismet_spam_protection', |
| 231 | 'type' => 'sectionend', |
| 232 | ], |
| 233 | ]; |
| 234 | break; |
| 235 | } |
| 236 | |
| 237 | /** |
| 238 | * Hide caching setting by default. |
| 239 | * |
| 240 | * @since 2.0 |
| 241 | */ |
| 242 | if ( apply_filters( 'give_settings_advanced_show_cache_setting', false ) ) { |
| 243 | array_splice( |
| 244 | $settings, |
| 245 | 1, |
| 246 | 0, |
| 247 | [ |
| 248 | [ |
| 249 | 'name' => __( 'Cache', 'give' ), |
| 250 | 'desc' => __( 'If caching is enabled the plugin will start caching custom post type related queries and reduce the overall load time.', 'give' ), |
| 251 | 'id' => 'cache', |
| 252 | 'type' => 'radio_inline', |
| 253 | 'default' => 'enabled', |
| 254 | 'options' => [ |
| 255 | 'enabled' => __( 'Enabled', 'give' ), |
| 256 | 'disabled' => __( 'Disabled', 'give' ), |
| 257 | ], |
| 258 | ], |
| 259 | ] |
| 260 | ); |
| 261 | } |
| 262 | |
| 263 | /** |
| 264 | * Filter the advanced settings. |
| 265 | * Backward compatibility: Please do not use this filter. This filter is deprecated in 1.8 |
| 266 | */ |
| 267 | $settings = apply_filters( 'give_settings_advanced', $settings ); |
| 268 | |
| 269 | /** |
| 270 | * Filter the settings. |
| 271 | * |
| 272 | * @param array $settings |
| 273 | * |
| 274 | * @since 1.8 |
| 275 | */ |
| 276 | $settings = apply_filters( 'give_get_settings_' . $this->id, $settings ); |
| 277 | |
| 278 | // Output. |
| 279 | return $settings; |
| 280 | } |
| 281 | |
| 282 | /** |
| 283 | * Get sections. |
| 284 | * |
| 285 | * @return array |
| 286 | * @since 1.8 |
| 287 | */ |
| 288 | public function get_sections() { |
| 289 | $sections = [ |
| 290 | 'advanced-options' => __( 'Advanced Options', 'give' ), |
| 291 | 'akismet-spam-protection' => __( 'Akismet SPAM Protection', 'give' ), |
| 292 | ]; |
| 293 | |
| 294 | return apply_filters( 'give_get_sections_' . $this->id, $sections ); |
| 295 | } |
| 296 | |
| 297 | |
| 298 | /** |
| 299 | * Render remove_cache_button field type |
| 300 | * |
| 301 | * @param array $field |
| 302 | * |
| 303 | * @since 2.1 |
| 304 | * @access public |
| 305 | */ |
| 306 | public function render_remove_cache_button( $field ) { |
| 307 | ?> |
| 308 | <tr valign="top" <?php echo ! empty( $field['wrapper_class'] ) ? 'class="' . $field['wrapper_class'] . '"' : ''; ?>> |
| 309 | <th scope="row" class="titledesc"> |
| 310 | <label |
| 311 | for="<?php echo esc_attr( $field['id'] ); ?>"><?php echo esc_html( $field['name'] ); ?></label> |
| 312 | </th> |
| 313 | <td class="give-forminp"> |
| 314 | <button type="button" id="<?php echo esc_attr( $field['id'] ); ?>" |
| 315 | class="button button-secondary"><?php echo esc_html( $field['buttonTitle'] ); ?></button> |
| 316 | <?php echo Give_Admin_Settings::get_field_description( $field ); ?> |
| 317 | </td> |
| 318 | </tr> |
| 319 | <?php |
| 320 | } |
| 321 | |
| 322 | |
| 323 | /** |
| 324 | * Validate setting |
| 325 | * |
| 326 | * @param array $options |
| 327 | * |
| 328 | * @since 2.2.0 |
| 329 | * @access public |
| 330 | */ |
| 331 | public function validate_settngs( $options ) { |
| 332 | // Sanitize data. |
| 333 | $akismet_spam_protection = isset( $options['akismet_spam_protection'] ) |
| 334 | ? $options['akismet_spam_protection'] |
| 335 | : ( give_check_akismet_key() ? 'enabled' : 'disabled' ); |
| 336 | |
| 337 | // Show error message if Akismet not configured and Admin try to save 'enabled' option. |
| 338 | if ( |
| 339 | give_is_setting_enabled( $akismet_spam_protection ) |
| 340 | && ! give_check_akismet_key() |
| 341 | ) { |
| 342 | Give_Admin_Settings::add_error( |
| 343 | 'give-akismet-protection', |
| 344 | __( 'Please properly configure Akismet to enable SPAM protection.', 'give' ) |
| 345 | ); |
| 346 | |
| 347 | give_update_option( 'akismet_spam_protection', 'disabled' ); |
| 348 | } |
| 349 | } |
| 350 | } |
| 351 | |
| 352 | endif; |
| 353 | |
| 354 | return new Give_Settings_Advanced(); |
| 355 |