admin
23 hours ago
api
3 years ago
database
5 months ago
deprecated
1 month ago
donors
5 months ago
emails
9 months ago
forms
23 hours ago
frontend
6 years ago
gateways
9 months ago
libraries
9 months ago
payments
2 months ago
actions.php
9 months ago
ajax-functions.php
3 days ago
class-give-async-process.php
1 year ago
class-give-background-updater.php
9 months ago
class-give-cache-setting.php
1 year ago
class-give-cache.php
9 months ago
class-give-cli-commands.php
1 year ago
class-give-comment.php
9 months ago
class-give-cron.php
9 months ago
class-give-donate-form.php
1 year ago
class-give-donor.php
2 years ago
class-give-email-access.php
5 years ago
class-give-license-handler.php
1 month ago
class-give-logging.php
9 months ago
class-give-readme-parser.php
4 years ago
class-give-roles.php
5 months ago
class-give-scripts.php
2 weeks ago
class-give-session.php
9 months ago
class-give-stats.php
6 years ago
class-give-template-loader.php
6 years ago
class-give-tooltips.php
6 years ago
class-give-translation.php
4 years ago
class-notices.php
9 months ago
country-functions.php
7 months ago
currencies-list.php
7 months ago
currency-functions.php
3 years ago
error-tracking.php
6 years ago
filters.php
9 months ago
formatting.php
9 months ago
install.php
9 months ago
login-register.php
2 years ago
misc-functions.php
1 month ago
plugin-compatibility.php
6 years ago
post-types.php
1 year ago
price-functions.php
6 years ago
process-donation.php
1 year ago
setting-functions.php
6 years ago
shortcodes.php
1 year ago
template-functions.php
1 year ago
user-functions.php
3 years ago
class-notices.php
756 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Admin Notices Class. |
| 4 | * |
| 5 | * @package Give |
| 6 | * @subpackage Admin/Notices |
| 7 | * @copyright Copyright (c) 2016, GiveWP |
| 8 | * @license https://opensource.org/licenses/gpl-license GNU Public License |
| 9 | * @since 1.8.9 |
| 10 | */ |
| 11 | |
| 12 | // Exit if accessed directly. |
| 13 | if ( ! defined( 'ABSPATH' ) ) { |
| 14 | exit; |
| 15 | } |
| 16 | |
| 17 | /** |
| 18 | * Give_Notices Class |
| 19 | * |
| 20 | * @since 1.8.9 |
| 21 | */ |
| 22 | class Give_Notices { |
| 23 | /** |
| 24 | * List of notices |
| 25 | * |
| 26 | * @var array |
| 27 | * @since 1.8.9 |
| 28 | * @access private |
| 29 | */ |
| 30 | private static $notices = []; |
| 31 | |
| 32 | |
| 33 | /** |
| 34 | * Flag to check if any notice auto dismissible among all notices |
| 35 | * |
| 36 | * @since 1.8.9 |
| 37 | * @access private |
| 38 | * @var bool |
| 39 | */ |
| 40 | private static $has_auto_dismissible_notice = false; |
| 41 | |
| 42 | /** |
| 43 | * Flag to check if any notice has dismiss interval among all notices |
| 44 | * |
| 45 | * @since 1.8.9 |
| 46 | * @access private |
| 47 | * @var bool |
| 48 | */ |
| 49 | private static $has_dismiss_interval_notice = false; |
| 50 | |
| 51 | /** |
| 52 | * Get things started. |
| 53 | * |
| 54 | * @since 1.8.9 |
| 55 | */ |
| 56 | public function __construct() { |
| 57 | add_action( 'admin_notices', [ $this, 'render_admin_notices' ], 999 ); |
| 58 | add_action( 'admin_footer', [$this, 'reveal_notices'] ); |
| 59 | add_action( 'give_dismiss_notices', [ $this, 'dismiss_notices' ] ); |
| 60 | |
| 61 | add_action( 'give_frontend_notices', [ $this, 'render_frontend_notices' ], 999 ); |
| 62 | add_action( 'give_pre_form_output', [ $this, 'render_frontend_form_notices' ], 10, 1 ); |
| 63 | add_action( 'give_ajax_donation_errors', [ $this, 'render_frontend_notices' ] ); |
| 64 | |
| 65 | /** |
| 66 | * Backward compatibility for deprecated params. |
| 67 | * |
| 68 | * @since 1.8.14 |
| 69 | */ |
| 70 | add_filter( 'give_register_notice_args', [ $this, 'bc_deprecated_params' ] ); |
| 71 | add_filter( 'give_frontend_errors_args', [ $this, 'bc_deprecated_params' ] ); |
| 72 | add_filter( 'give_frontend_notice_args', [ $this, 'bc_deprecated_params' ] ); |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Add backward compatibility to deprecated params. |
| 77 | * |
| 78 | * @since 1.8.14 |
| 79 | * @access public |
| 80 | * |
| 81 | * @param array $args Array of notice params |
| 82 | * |
| 83 | * @return array |
| 84 | */ |
| 85 | public function bc_deprecated_params( $args ) { |
| 86 | /** |
| 87 | * Param: auto_dismissible |
| 88 | * deprecated in 1.8.14 |
| 89 | * |
| 90 | * Check if auto_dismissible is set and it true then unset and change dismissible parameter value to auto |
| 91 | */ |
| 92 | if ( isset( $args['auto_dismissible'] ) ) { |
| 93 | if ( ! empty( $args['auto_dismissible'] ) ) { |
| 94 | $args['dismissible'] = 'auto'; |
| 95 | } |
| 96 | // unset auto_dismissible as it has been deprecated. |
| 97 | unset( $args['auto_dismissible'] ); |
| 98 | } |
| 99 | |
| 100 | return $args; |
| 101 | } |
| 102 | |
| 103 | /** |
| 104 | * Register notice. |
| 105 | * |
| 106 | * @since 1.8.9 |
| 107 | * @access public |
| 108 | * |
| 109 | * @param $notice_args |
| 110 | * |
| 111 | * @return bool |
| 112 | */ |
| 113 | public function register_notice( $notice_args ) { |
| 114 | // Bailout. |
| 115 | if ( empty( $notice_args['id'] ) || array_key_exists( $notice_args['id'], self::$notices ) ) { |
| 116 | return false; |
| 117 | } |
| 118 | |
| 119 | $notice_args = wp_parse_args( |
| 120 | $notice_args, |
| 121 | [ |
| 122 | 'id' => '', |
| 123 | 'description' => '', |
| 124 | |
| 125 | /* |
| 126 | * Add custom notice html |
| 127 | * Note: This param has more priority than description, so if you use both params then this one will be used |
| 128 | * for generating notice html. Most features of the notice attach to core generated html, so if you set |
| 129 | * custom html then please add required classes and data attribute which help to apply features on notice. |
| 130 | * |
| 131 | * @since 1.8.16 |
| 132 | */ |
| 133 | 'description_html' => '', |
| 134 | |
| 135 | /* |
| 136 | * Add New Parameter and remove the auto_dismissible parameter. |
| 137 | * Value: auto/true/false |
| 138 | * |
| 139 | * @since 1.8.14 |
| 140 | */ |
| 141 | 'dismissible' => true, |
| 142 | |
| 143 | // Value: error/warning/success/info/updated |
| 144 | 'type' => 'error', |
| 145 | |
| 146 | // Value: null/user/all |
| 147 | 'dismissible_type' => null, |
| 148 | |
| 149 | // Value: shortly/permanent/null/custom |
| 150 | 'dismiss_interval' => null, |
| 151 | |
| 152 | // Only set it when custom is defined. |
| 153 | 'dismiss_interval_time' => null, |
| 154 | |
| 155 | ] |
| 156 | ); |
| 157 | |
| 158 | /** |
| 159 | * Filter to modify Notice args before it get add |
| 160 | * |
| 161 | * @since 1.8.14 |
| 162 | */ |
| 163 | $notice_args = apply_filters( 'give_register_notice_args', $notice_args ); |
| 164 | |
| 165 | // Set extra dismiss links if any. |
| 166 | if ( false !== strpos( $notice_args['description'], 'data-dismiss-interval' ) ) { |
| 167 | |
| 168 | preg_match_all( '/data-([^"]*)="([^"]*)"/', $notice_args['description'], $extra_notice_dismiss_link ); |
| 169 | |
| 170 | if ( ! empty( $extra_notice_dismiss_link ) ) { |
| 171 | $extra_notice_dismiss_links = array_chunk( current( $extra_notice_dismiss_link ), 3 ); |
| 172 | foreach ( $extra_notice_dismiss_links as $extra_notice_dismiss_link ) { |
| 173 | // Create array of key ==> value by parsing query string created after renaming data attributes. |
| 174 | $data_attribute_query_str = str_replace( |
| 175 | [ 'data-', '-', '"' ], |
| 176 | [ |
| 177 | '', |
| 178 | '_', |
| 179 | '', |
| 180 | ], |
| 181 | implode( '&', $extra_notice_dismiss_link ) |
| 182 | ); |
| 183 | |
| 184 | $notice_args['extra_links'][] = wp_parse_args( $data_attribute_query_str ); |
| 185 | } |
| 186 | } |
| 187 | } |
| 188 | |
| 189 | self::$notices[ $notice_args['id'] ] = $notice_args; |
| 190 | |
| 191 | // Auto set show param if not already set. |
| 192 | if ( ! isset( self::$notices[ $notice_args['id'] ]['show'] ) ) { |
| 193 | self::$notices[ $notice_args['id'] ]['show'] = $this->is_notice_dismissed( $notice_args ) ? false : true; |
| 194 | } |
| 195 | |
| 196 | // Auto set time interval for shortly. |
| 197 | if ( 'shortly' === self::$notices[ $notice_args['id'] ]['dismiss_interval'] ) { |
| 198 | self::$notices[ $notice_args['id'] ]['dismiss_interval_time'] = DAY_IN_SECONDS; |
| 199 | } |
| 200 | |
| 201 | return true; |
| 202 | } |
| 203 | |
| 204 | /** |
| 205 | * Display notice. |
| 206 | * |
| 207 | * @since 1.8.9 |
| 208 | */ |
| 209 | public function render_admin_notices() { |
| 210 | /* @var WP_Screen $wp_screen */ |
| 211 | $wp_screen = get_current_screen(); |
| 212 | |
| 213 | // Bailout. |
| 214 | if ( empty( self::$notices ) ) { |
| 215 | return; |
| 216 | } |
| 217 | |
| 218 | // Do not render notices on Gutenberg editor page. |
| 219 | if ( |
| 220 | method_exists( $wp_screen, 'is_block_editor' ) |
| 221 | && $wp_screen->is_block_editor() |
| 222 | ) { |
| 223 | return; |
| 224 | } |
| 225 | |
| 226 | // Do not render notices on these pages as well. |
| 227 | // We don't want to annoy admins with notices on important screens like WP or GiveWP updates, etc. |
| 228 | if ( |
| 229 | 'update-core' === $wp_screen->id |
| 230 | || 'give_forms_page_give-addons' === $wp_screen->id |
| 231 | || 'give_forms_page_give-updates' === $wp_screen->id |
| 232 | ) { |
| 233 | return; |
| 234 | } |
| 235 | |
| 236 | $output = ''; |
| 237 | |
| 238 | foreach ( self::$notices as $notice_id => $notice ) { |
| 239 | // Check flag set to true to show notice. |
| 240 | if ( ! $notice['show'] ) { |
| 241 | continue; |
| 242 | } |
| 243 | |
| 244 | // Render custom html. |
| 245 | if ( ! empty( $notice['description_html'] ) ) { |
| 246 | $output .= "{$notice['description_html']} \n"; |
| 247 | continue; |
| 248 | } |
| 249 | |
| 250 | // Check if notice dismissible or not. |
| 251 | if ( ! self::$has_auto_dismissible_notice ) { |
| 252 | self::$has_auto_dismissible_notice = ( 'auto' === $notice['dismissible'] ); |
| 253 | } |
| 254 | |
| 255 | // Check if notice dismissible or not. |
| 256 | if ( ! self::$has_dismiss_interval_notice ) { |
| 257 | self::$has_dismiss_interval_notice = $notice['dismiss_interval']; |
| 258 | } |
| 259 | |
| 260 | $css_id = ( false === strpos( $notice['id'], 'give' ) ? "give-{$notice['id']}" : $notice['id'] ); |
| 261 | |
| 262 | $css_class = 'give-notice notice ' . ( empty( $notice['dismissible'] ) ? 'non' : 'is' ) . "-dismissible {$notice['type']} notice-{$notice['type']}"; |
| 263 | $output .= sprintf( |
| 264 | '<div id="%1$s" class="%2$s" data-dismissible="%3$s" data-dismissible-type="%4$s" data-dismiss-interval="%5$s" data-notice-id="%6$s" data-security="%7$s" data-dismiss-interval-time="%8$s" style="display: none">' . " \n", |
| 265 | $css_id, |
| 266 | $css_class, |
| 267 | give_clean( $notice['dismissible'] ), |
| 268 | $notice['dismissible_type'], |
| 269 | $notice['dismiss_interval'], |
| 270 | $notice['id'], |
| 271 | empty( $notice['dismissible_type'] ) ? '' : wp_create_nonce( "give_edit_{$notice_id}_notice" ), |
| 272 | $notice['dismiss_interval_time'] |
| 273 | ); |
| 274 | |
| 275 | $output .= ( 0 === strpos( $notice['description'], '<div' ) || 0 === strpos( $notice['description'], '<p' ) ? $notice['description'] : "<p>{$notice['description']}</p>" ); |
| 276 | $output .= "</div> \n"; |
| 277 | } |
| 278 | |
| 279 | echo $output; |
| 280 | |
| 281 | $this->print_js(); |
| 282 | } |
| 283 | |
| 284 | |
| 285 | /** |
| 286 | * Render give frontend notices. |
| 287 | * |
| 288 | * @since 3.1.0 Render errors on Ajax request (Donation form validation - v2 forms) |
| 289 | * @since 2.32.0 Display registered error on donation form. |
| 290 | * @since 1.8.9 |
| 291 | * @access public |
| 292 | * |
| 293 | * @param int $form_id |
| 294 | */ |
| 295 | public function render_frontend_notices($form_id = 0) |
| 296 | { |
| 297 | $errors = give_get_errors(); |
| 298 | |
| 299 | $request_form_id = isset($_REQUEST['form-id']) ? absint($_REQUEST['form-id']) : 0; |
| 300 | |
| 301 | // Sanity checks first: |
| 302 | // - Ensure that gateway returned errors display on the appropriate form. |
| 303 | // - Error should exist. |
| 304 | if (! $errors || ($request_form_id && $request_form_id !== $form_id)) { |
| 305 | return; |
| 306 | } |
| 307 | |
| 308 | self::print_frontend_errors($errors); |
| 309 | give_clear_errors(); |
| 310 | } |
| 311 | |
| 312 | /** |
| 313 | * Renders notices for different actions depending on |
| 314 | * the type of form display option. |
| 315 | * |
| 316 | * @since 2.2 |
| 317 | * @access public |
| 318 | * |
| 319 | * @param int $form_id Form ID. |
| 320 | * |
| 321 | * @return void |
| 322 | */ |
| 323 | public function render_frontend_form_notices( $form_id ) { |
| 324 | $display_option = give_get_meta( $form_id, '_give_payment_display', true ); |
| 325 | |
| 326 | if ( 'modal' === $display_option ) { |
| 327 | add_action( 'give_payment_mode_top', [ $this, 'render_frontend_notices' ] ); |
| 328 | } else { |
| 329 | add_action( 'give_pre_form', [ $this, 'render_frontend_notices' ], 11 ); |
| 330 | } |
| 331 | } |
| 332 | |
| 333 | /** |
| 334 | * Print notice js. |
| 335 | * |
| 336 | * @since 1.8.9 |
| 337 | * @access private |
| 338 | */ |
| 339 | private function print_js() { |
| 340 | if ( self::$has_auto_dismissible_notice ) : |
| 341 | ?> |
| 342 | <script> |
| 343 | jQuery(document).ready(function () { |
| 344 | // auto hide setting message in 5 seconds. |
| 345 | window.setTimeout( |
| 346 | function () { |
| 347 | jQuery('.give-notice[data-dismissible="auto"]').slideUp(); |
| 348 | }, |
| 349 | 5000 |
| 350 | ); |
| 351 | }) |
| 352 | </script> |
| 353 | <?php |
| 354 | endif; |
| 355 | |
| 356 | if ( self::$has_dismiss_interval_notice ) : |
| 357 | ?> |
| 358 | <script> |
| 359 | jQuery(document).ready(function () { |
| 360 | var $body = jQuery('body'); |
| 361 | |
| 362 | $body.on('click', '.give_dismiss_notice', function (e) { |
| 363 | var $parent = jQuery(this).parents('.give-notice'), |
| 364 | custom_notice_data = { |
| 365 | 'dismissible_type': jQuery(this).data('dismissible-type'), |
| 366 | 'dismiss_interval': jQuery(this).data('dismiss-interval'), |
| 367 | 'dismiss_interval_time': jQuery(this).data('dismiss-interval-time') |
| 368 | }; |
| 369 | |
| 370 | $parent.find('button.notice-dismiss').trigger('click', [custom_notice_data]); |
| 371 | return false; |
| 372 | }); |
| 373 | |
| 374 | $body.on('click', 'button.notice-dismiss', function (e, custom_notice_data) { |
| 375 | var $parent = jQuery(this).parents('.give-notice'), |
| 376 | custom_notice_data = custom_notice_data || {}; |
| 377 | |
| 378 | e.preventDefault(); |
| 379 | |
| 380 | var data = { |
| 381 | 'give-action': 'dismiss_notices', |
| 382 | 'notice_id': $parent.data('notice-id'), |
| 383 | 'dismissible_type': $parent.data('dismissible-type'), |
| 384 | 'dismiss_interval': $parent.data('dismiss-interval'), |
| 385 | 'dismiss_interval_time': $parent.data('dismiss-interval-time'), |
| 386 | '_wpnonce': $parent.data('security') |
| 387 | }; |
| 388 | |
| 389 | if (Object.keys(custom_notice_data).length) { |
| 390 | jQuery.extend(data, custom_notice_data); |
| 391 | } |
| 392 | |
| 393 | // Bailout. |
| 394 | if ( |
| 395 | !data.dismiss_interval || |
| 396 | !data.dismissible_type |
| 397 | ) { |
| 398 | return false; |
| 399 | } |
| 400 | |
| 401 | jQuery.post( |
| 402 | '<?php echo admin_url(); ?>admin-ajax.php', |
| 403 | data, |
| 404 | function (response) { |
| 405 | |
| 406 | }) |
| 407 | }) |
| 408 | }); |
| 409 | </script> |
| 410 | <?php |
| 411 | endif; |
| 412 | } |
| 413 | |
| 414 | /** |
| 415 | * Show notices |
| 416 | * Note: only for internal use |
| 417 | * |
| 418 | * @since 4.9.0 rename function - PHP 8 compatibility |
| 419 | * @since 2.3.0 |
| 420 | */ |
| 421 | public function reveal_notices() { |
| 422 | ?> |
| 423 | <script> |
| 424 | jQuery(document).ready(function($){ |
| 425 | // Fix notice appearance issue. |
| 426 | var give_notices = $('.give-notice'); |
| 427 | if( give_notices.length ) { |
| 428 | give_notices.show(); |
| 429 | } |
| 430 | }); |
| 431 | </script> |
| 432 | <?php |
| 433 | } |
| 434 | |
| 435 | |
| 436 | /** |
| 437 | * Hide notice. |
| 438 | * |
| 439 | * @since 1.8.9 |
| 440 | * @access public |
| 441 | */ |
| 442 | public function dismiss_notices() { |
| 443 | $_post = give_clean( $_POST ); |
| 444 | $notice_id = esc_attr( $_post['notice_id'] ); |
| 445 | |
| 446 | // Bailout. |
| 447 | if ( |
| 448 | empty( $notice_id ) || |
| 449 | empty( $_post['dismissible_type'] ) || |
| 450 | empty( $_post['dismiss_interval'] ) || |
| 451 | ! check_ajax_referer( "give_edit_{$notice_id}_notice", '_wpnonce' ) |
| 452 | ) { |
| 453 | wp_send_json_error(); |
| 454 | } |
| 455 | |
| 456 | $notice_key = Give()->notices->get_notice_key( $notice_id, $_post['dismiss_interval'] ); |
| 457 | if ( 'user' === $_post['dismissible_type'] ) { |
| 458 | $current_user = wp_get_current_user(); |
| 459 | $notice_key = Give()->notices->get_notice_key( $notice_id, $_post['dismiss_interval'], $current_user->ID ); |
| 460 | } |
| 461 | |
| 462 | $notice_dismiss_time = ! empty( $_post['dismiss_interval_time'] ) ? $_post['dismiss_interval_time'] : null; |
| 463 | |
| 464 | // Save option to hide notice. |
| 465 | Give_Cache::set( $notice_key, true, $notice_dismiss_time, true ); |
| 466 | |
| 467 | /** |
| 468 | * Fire the action when notice dismissed |
| 469 | * |
| 470 | * @since 2.2.0 |
| 471 | */ |
| 472 | do_action( 'give_notice_dismissed', $_post ); |
| 473 | |
| 474 | wp_send_json_success(); |
| 475 | } |
| 476 | |
| 477 | |
| 478 | /** |
| 479 | * Get notice key. |
| 480 | * |
| 481 | * @since 1.8.9 |
| 482 | * @access public |
| 483 | * |
| 484 | * @param string $notice_id |
| 485 | * @param string $dismiss_interval |
| 486 | * @param int $user_id |
| 487 | * |
| 488 | * @return string |
| 489 | */ |
| 490 | public function get_notice_key( $notice_id, $dismiss_interval = null, $user_id = 0 ) { |
| 491 | $notice_key = "_give_notice_{$notice_id}"; |
| 492 | |
| 493 | if ( ! empty( $dismiss_interval ) ) { |
| 494 | $notice_key .= "_{$dismiss_interval}"; |
| 495 | } |
| 496 | |
| 497 | if ( $user_id ) { |
| 498 | $notice_key .= "_{$user_id}"; |
| 499 | } |
| 500 | |
| 501 | $notice_key = sanitize_key( $notice_key ); |
| 502 | |
| 503 | return $notice_key; |
| 504 | } |
| 505 | |
| 506 | |
| 507 | /** |
| 508 | * Get notice dismiss link. |
| 509 | * |
| 510 | * @param $notice_args |
| 511 | * |
| 512 | * @return string |
| 513 | */ |
| 514 | public function get_dismiss_link( $notice_args ) { |
| 515 | $notice_args = wp_parse_args( |
| 516 | $notice_args, |
| 517 | [ |
| 518 | 'title' => __( 'Click here', 'give' ), |
| 519 | 'dismissible_type' => '', |
| 520 | 'dismiss_interval' => '', |
| 521 | 'dismiss_interval_time' => null, |
| 522 | ] |
| 523 | ); |
| 524 | |
| 525 | return sprintf( |
| 526 | '<a href="#" class="give_dismiss_notice" data-dismissible-type="%1$s" data-dismiss-interval="%2$s" data-dismiss-interval-time="%3$s">%4$s</a>', |
| 527 | $notice_args['dismissible_type'], |
| 528 | $notice_args['dismiss_interval'], |
| 529 | $notice_args['dismiss_interval_time'], |
| 530 | $notice_args['title'] |
| 531 | ); |
| 532 | } |
| 533 | |
| 534 | |
| 535 | /** |
| 536 | * Check if notice dismissed or not |
| 537 | * |
| 538 | * @since 1.8.9 |
| 539 | * @access public |
| 540 | * |
| 541 | * @param array $notice |
| 542 | * |
| 543 | * @return bool|null |
| 544 | */ |
| 545 | public function is_notice_dismissed( $notice ) { |
| 546 | $notice_key = $this->get_notice_key( $notice['id'], $notice['dismiss_interval'] ); |
| 547 | $is_notice_dismissed = false; |
| 548 | |
| 549 | if ( 'user' === $notice['dismissible_type'] ) { |
| 550 | $current_user = wp_get_current_user(); |
| 551 | $notice_key = Give()->notices->get_notice_key( $notice['id'], $notice['dismiss_interval'], $current_user->ID ); |
| 552 | } |
| 553 | |
| 554 | $notice_data = Give_Cache::get( $notice_key, true ); |
| 555 | |
| 556 | // Find notice dismiss link status if notice has extra dismissible links. |
| 557 | if ( ( empty( $notice_data ) || is_wp_error( $notice_data ) ) && ! empty( $notice['extra_links'] ) ) { |
| 558 | |
| 559 | foreach ( $notice['extra_links'] as $extra_link ) { |
| 560 | $new_notice_data = wp_parse_args( $extra_link, $notice ); |
| 561 | unset( $new_notice_data['extra_links'] ); |
| 562 | |
| 563 | if ( $is_notice_dismissed = $this->is_notice_dismissed( $new_notice_data ) ) { |
| 564 | return $is_notice_dismissed; |
| 565 | } |
| 566 | } |
| 567 | } |
| 568 | |
| 569 | $is_notice_dismissed = ! empty( $notice_data ) && ! is_wp_error( $notice_data ); |
| 570 | |
| 571 | return $is_notice_dismissed; |
| 572 | } |
| 573 | |
| 574 | |
| 575 | /** |
| 576 | * Print frontend errors. |
| 577 | * |
| 578 | * @since 1.8.9 |
| 579 | * @access public |
| 580 | * |
| 581 | * @param array $errors |
| 582 | */ |
| 583 | public static function print_frontend_errors( $errors ) { |
| 584 | // Bailout. |
| 585 | if ( ! $errors ) { |
| 586 | return; |
| 587 | } |
| 588 | |
| 589 | /** |
| 590 | * Change auto_dismissible to dismissible and set the value to true |
| 591 | * |
| 592 | * @since 1.8.14 |
| 593 | */ |
| 594 | $default_notice_args = [ |
| 595 | 'dismissible' => true, |
| 596 | 'dismiss_interval' => 5000, |
| 597 | ]; |
| 598 | |
| 599 | // Note: we will remove give_errors class in future. |
| 600 | $classes = apply_filters( 'give_error_class', [ 'give_notices', 'give_errors' ] ); |
| 601 | |
| 602 | echo sprintf( '<div class="%s">', implode( ' ', $classes ) ); |
| 603 | |
| 604 | // Loop error codes and display errors. |
| 605 | foreach ( $errors as $error_id => $error ) { |
| 606 | // Backward compatibility v<1.8.11 |
| 607 | if ( is_string( $error ) ) { |
| 608 | $error = [ |
| 609 | 'message' => $error, |
| 610 | 'notice_args' => [], |
| 611 | ]; |
| 612 | } |
| 613 | |
| 614 | $notice_args = wp_parse_args( $error['notice_args'], $default_notice_args ); |
| 615 | |
| 616 | /** |
| 617 | * Filter to modify Frontend Errors args before errors is display. |
| 618 | * |
| 619 | * @since 1.8.14 |
| 620 | */ |
| 621 | $notice_args = apply_filters( 'give_frontend_errors_args', $notice_args ); |
| 622 | |
| 623 | echo sprintf( |
| 624 | '<div class="give_error give_notice" id="give_error_%1$s" data-dismissible="%2$s" data-dismiss-interval="%3$d"> |
| 625 | <p><strong>%4$s</strong>: %5$s</p> |
| 626 | </div>', |
| 627 | $error_id, |
| 628 | give_clean( $notice_args['dismissible'] ), |
| 629 | absint( $notice_args['dismiss_interval'] ), |
| 630 | esc_html__( 'Error', 'give' ), |
| 631 | $error['message'] |
| 632 | ); |
| 633 | } |
| 634 | |
| 635 | echo '</div>'; |
| 636 | } |
| 637 | |
| 638 | /** |
| 639 | * Print frontend notice. |
| 640 | * Notice: notice type can be success/error/warning |
| 641 | * |
| 642 | * @since 3.7.0 Escape attributes |
| 643 | * @since 1.8.9 |
| 644 | * @access public |
| 645 | * |
| 646 | * @param string $message |
| 647 | * @param bool $echo |
| 648 | * @param string $notice_type |
| 649 | * @param array $notice_args |
| 650 | * |
| 651 | * @return string |
| 652 | */ |
| 653 | public static function print_frontend_notice( $message, $echo = true, $notice_type = 'warning', $notice_args = [] ) { |
| 654 | if ( empty( $message ) ) { |
| 655 | return ''; |
| 656 | } |
| 657 | |
| 658 | /** |
| 659 | * Change auto_dismissible to dismissible and set the value to true |
| 660 | * |
| 661 | * @since 1.8.14 |
| 662 | */ |
| 663 | $default_notice_args = [ |
| 664 | 'dismissible' => false, |
| 665 | 'dismiss_type' => 'auto', |
| 666 | 'dismiss_interval' => 5000, |
| 667 | ]; |
| 668 | |
| 669 | $notice_args = wp_parse_args( $notice_args, $default_notice_args ); |
| 670 | |
| 671 | // Notice dismissible must be true for dismiss type. |
| 672 | $notice_args['dismiss_type'] = ! $notice_args['dismissible'] ? '' : $notice_args['dismiss_type']; |
| 673 | |
| 674 | /** |
| 675 | * Filter to modify Frontend notice args before notices is display. |
| 676 | * |
| 677 | * @since 1.8.14 |
| 678 | */ |
| 679 | $notice_args = apply_filters( 'give_frontend_notice_args', $notice_args ); |
| 680 | |
| 681 | $close_icon = 'manual' === $notice_args['dismiss_type'] ? |
| 682 | sprintf( |
| 683 | '<img class="notice-dismiss give-notice-close" src="%s" />', |
| 684 | esc_url( GIVE_PLUGIN_URL . 'build/assets/dist/images/close.svg' ) |
| 685 | ) : |
| 686 | ''; |
| 687 | |
| 688 | // Note: we will remove give_errors class in future. |
| 689 | $error = sprintf( |
| 690 | '<div class="give_notices give_errors" id="give_error_%1$s"> |
| 691 | <p class="give_notice give_%1$s" data-dismissible="%2$s" data-dismiss-interval="%3$d" data-dismiss-type="%4$s"> |
| 692 | %5$s |
| 693 | </p> |
| 694 | %6$s |
| 695 | </div>', |
| 696 | esc_attr($notice_type), |
| 697 | esc_attr( $notice_args['dismissible'] ), |
| 698 | esc_attr( $notice_args['dismiss_interval'] ), |
| 699 | esc_attr( $notice_args['dismiss_type'] ), |
| 700 | esc_html($message), |
| 701 | $close_icon |
| 702 | ); |
| 703 | |
| 704 | if ( ! $echo ) { |
| 705 | return $error; |
| 706 | } |
| 707 | |
| 708 | echo $error; |
| 709 | } |
| 710 | |
| 711 | /** |
| 712 | * Print Inline Notice. |
| 713 | * Note: dismissible feature will note work if notice will add to dom by javascript after document load. |
| 714 | * |
| 715 | * @param array $notice_args An array of notice arguments. |
| 716 | * |
| 717 | * @todo Implement render_admin_notices function within this function in future. |
| 718 | * |
| 719 | * @access public |
| 720 | * @since 1.8.17 |
| 721 | * |
| 722 | * @return string |
| 723 | */ |
| 724 | public function print_admin_notices( $notice_args = [] ) { |
| 725 | // Bailout. |
| 726 | if ( empty( $notice_args['description'] ) ) { |
| 727 | return ''; |
| 728 | } |
| 729 | |
| 730 | $defaults = [ |
| 731 | 'id' => '', |
| 732 | 'echo' => true, |
| 733 | 'notice_type' => 'warning', |
| 734 | 'dismissible' => true, |
| 735 | ]; |
| 736 | $notice_args = wp_parse_args( $notice_args, $defaults ); |
| 737 | |
| 738 | $output = ''; |
| 739 | $css_id = ! empty( $notice_args['id'] ) ? $notice_args['id'] : uniqid( 'give-inline-notice-' ); |
| 740 | $css_class = "notice-{$notice_args['notice_type']} give-notice notice inline"; |
| 741 | $css_class .= ( $notice_args['dismissible'] ) ? ' is-dismissible' : ''; |
| 742 | $output .= sprintf( |
| 743 | '<div id="%1$s" class="%2$s"><p>%3$s</p></div>', |
| 744 | $css_id, |
| 745 | $css_class, |
| 746 | $notice_args['description'] |
| 747 | ); |
| 748 | |
| 749 | if ( ! $notice_args['echo'] ) { |
| 750 | return $output; |
| 751 | } |
| 752 | |
| 753 | echo $output; |
| 754 | } |
| 755 | } |
| 756 |