Created
December 13, 2020 08:20
-
-
Save futtta/e671cbcee90f244a251e2c888317b425 to your computer and use it in GitHub Desktop.
quick draft of how "maximum times seen" could work
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
/** | |
* Persist Admin notices Dismissal | |
* | |
* Copyright (C) 2016 Collins Agbonghama <http://w3guy.com> | |
* | |
* This program is free software: you can redistribute it and/or modify | |
* it under the terms of the GNU General Public License as published by | |
* the Free Software Foundation, either version 3 of the License, or | |
* (at your option) any later version. | |
* | |
* This program is distributed in the hope that it will be useful, | |
* but WITHOUT ANY WARRANTY; without even the implied warranty of | |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
* GNU General Public License for more details. | |
* | |
* You should have received a copy of the GNU General Public License | |
* along with this program. If not, see <http://www.gnu.org/licenses/>. | |
* | |
* @package Persist Admin notices Dismissal | |
* @author Collins Agbonghama | |
* @author Andy Fragen | |
* @license http://www.gnu.org/licenses GNU General Public License | |
* @version 1.4.1 | |
*/ | |
/** | |
* Exit if called directly. | |
*/ | |
if ( ! defined( 'ABSPATH' ) ) { | |
die; | |
} | |
if ( ! class_exists( 'PAnD' ) ) { | |
/** | |
* Class PAnD | |
*/ | |
class PAnD { | |
/** | |
* Init hooks. | |
*/ | |
public static function init() { | |
add_action( 'admin_enqueue_scripts', array( __CLASS__, 'load_script' ) ); | |
add_action( 'wp_ajax_dismiss_admin_notice', array( __CLASS__, 'dismiss_admin_notice' ) ); | |
} | |
/** | |
* Enqueue javascript and variables. | |
*/ | |
public static function load_script() { | |
if ( is_customize_preview() ) { | |
return; | |
} | |
wp_enqueue_script( | |
'dismissible-notices', | |
plugins_url( 'dismiss-notice.js', __FILE__ ), | |
array( 'jquery', 'common' ), | |
false, | |
true | |
); | |
wp_localize_script( | |
'dismissible-notices', | |
'dismissible_notice', | |
array( | |
'nonce' => wp_create_nonce( 'dismissible-notice' ), | |
) | |
); | |
} | |
/** | |
* Handles Ajax request to persist notices dismissal. | |
* Uses check_ajax_referer to verify nonce. | |
*/ | |
public static function dismiss_admin_notice() { | |
$option_name = sanitize_text_field( $_POST['option_name'] ); | |
$dismissible_length = sanitize_text_field( $_POST['dismissible_length'] ); | |
if ( 'forever' != $dismissible_length ) { | |
// If $dismissible_length is not an integer default to 1 | |
$dismissible_length = ( 0 == absint( $dismissible_length ) ) ? 1 : $dismissible_length; | |
$dismissible_length = strtotime( absint( $dismissible_length ) . ' days' ); | |
} | |
check_ajax_referer( 'dismissible-notice', 'nonce' ); | |
self::set_admin_notice_cache( $option_name, $dismissible_length ); | |
wp_die(); | |
} | |
/** | |
* Is admin notice active? | |
* | |
* @param string $arg data-dismissible content of notice. | |
* | |
* @return bool | |
*/ | |
public static function is_admin_notice_active( $arg ) { | |
$array = explode( '-', $arg ); | |
$length = array_pop( $array ); | |
$option_name = implode( '-', $array ); | |
$db_record = self::get_admin_notice_cache( $option_name ); | |
if ( 'forever' == $db_record ) { | |
return false; | |
} elseif ( absint( $db_record ) >= time() ) { | |
return false; | |
} else { | |
$max_display = apply_filters( 'pand_maximum_notice_display', false, $arg ); | |
if ( $max_display ) { | |
$seen_counter = (int) self::get_admin_notice_cache( $option_name, true ); | |
if ( $seen_counter > $max_display ) { | |
return false; | |
} else { | |
$seen_counter++; | |
self::set_admin_notice_cache( $option_name, $seen_counter, true ); | |
return true; | |
} | |
} | |
return true; | |
} | |
} | |
/** | |
* Returns admin notice cached timeout. | |
* | |
* @access public | |
* | |
* @param string|bool $id admin notice name or false. | |
* | |
* @return array|bool The timeout. False if expired. | |
*/ | |
public static function get_admin_notice_cache( $id = false, $seencount = false ) { | |
if ( ! $id ) { | |
return false; | |
} | |
if ( $seencount ) { | |
$prefix = 'pand-seen-'; | |
} else { | |
$prefix = 'pand-'; | |
} | |
$cache_key = $prefix . md5( $id ); | |
$timeout = get_site_option( $cache_key ); | |
if ( $seencount ) { | |
return $timeout; | |
} | |
$timeout = 'forever' === $timeout ? time() + 60 : $timeout; | |
if ( empty( $timeout ) || time() > $timeout ) { | |
return false; | |
} | |
return $timeout; | |
} | |
/** | |
* Sets admin notice timeout in site option. | |
* | |
* @access public | |
* | |
* @param string $id Data Identifier. | |
* @param string|bool $timeout Timeout for admin notice. | |
* | |
* @return bool | |
*/ | |
public static function set_admin_notice_cache( $id, $timeout, $seencount = false ) { | |
if ( $seencount ) { | |
$prefix = 'pand-seen-'; | |
} else { | |
$prefix = 'pand-'; | |
} | |
$cache_key = $prefix . md5( $id ); | |
update_site_option( $cache_key, $timeout ); | |
return true; | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment