%s function returned false).',
$this->text_domain ), 'is_admin_bar_showing()' ) . ' ';
$msg_text .= __( 'As a consequence, showing discreet notices in the admin toolbar is not possible.', $this->text_domain ) . ' ';
$msg_text .= __( 'Please diagnose the issue to re-enable the admin toolbar.', $this->text_domain ) . ' ';
$notice_key = 'is_admin-is_admin_bar_showing-returned-false';
/*
* Clear all notices and show only this error.
*/
$this->clear();
$this->err( $msg_text, $user_id, $notice_key );
}
if ( empty( $notice_types ) ) { // Just in case.
return;
}
/*
* An alternative to the 'admin_head' action hook to add notices.
*/
$action_name = 'sucom_show_admin_notices';
if ( ! empty( $this->p->debug->enabled ) ) {
$this->p->debug->log( 'doing action \'' . $action_name . '\'' );
}
do_action( 'sucom_show_admin_notices', $user_id );
/*
* Exit early if this is a block editor page. The notices will be retrieved using an ajax call on page load
* and post save.
*/
if ( SucomUtilWP::doing_block_editor() ) {
if ( ! empty( $this->p->debug->enabled ) ) {
$this->p->debug->log( 'exiting early: doing block editor is true' );
}
return;
}
if ( ! empty( $this->p->debug->enabled ) ) {
$this->p->debug->log( 'doing block editor is false' );
}
$nag_html = '';
$msg_html = '';
$user_dismissed = $user_id ? get_user_option( $this->dismiss_name, $user_id ) : false; // Note that $user_id is the second argument.
$update_dismissed = false;
$this->has_shown = true;
$this->load_notice_cache( $user_id ); // Read and merge notices from transient cache.
$this->load_update_notices( $user_id );
/*
* Loop through all the msg types and show them all.
*/
foreach ( $notice_types as $msg_type ) {
if ( ! isset( $this->notice_cache[ $user_id ][ $msg_type ] ) ) { // Just in case.
continue;
}
foreach ( $this->notice_cache[ $user_id ][ $msg_type ] as $msg_key => $payload ) {
$this->unload_notice_cache( $user_id, $msg_type, $msg_key );
if ( empty( $payload[ 'msg_text' ] ) ) { // Nothing to show.
continue;
}
/*
* Make sure the notice has not exceeded its TTL.
*
* A 'notice_ttl' value of 0 disables the notice message expiration.
*/
if ( ! empty( $payload[ 'notice_time' ] ) && ! empty( $payload[ 'notice_ttl' ] ) ) {
if ( time() > $payload[ 'notice_time' ] + $payload[ 'notice_ttl' ] ) {
continue;
}
}
if ( ! empty( $payload[ 'dismiss_time' ] ) ) { // True or seconds greater than 0.
/*
* Check for automatically hidden errors and/or warnings.
*/
if ( ! empty( $payload[ 'notice_key' ] ) && isset( $user_dismissed[ $payload[ 'notice_key' ] ] ) ) {
$current_time = time();
$dismiss_time = $user_dismissed[ $payload[ 'notice_key' ] ]; // Get time for key.
if ( empty( $dismiss_time ) || $dismiss_time > $current_time ) { // 0 or time in future.
$payload[ 'hidden' ] = true;
} else { // Dismiss has expired.
unset( $user_dismissed[ $payload[ 'notice_key' ] ] );
$update_dismissed = true; // Update the user meta when done.
}
}
}
if ( 'nag' === $msg_type ) {
if ( empty( $nag_html ) ) { // Only show a single nag message at a time.
$nag_html .= $this->get_notice_html( $msg_type, $payload );
}
} else $msg_html .= $this->get_notice_html( $msg_type, $payload );
}
}
/*
* Don't save unless we've changed something.
*/
if ( $user_id && $update_dismissed ) {
if ( empty( $user_dismissed ) ) {
delete_user_option( $user_id, $this->dismiss_name, $global = false );
} else update_user_option( $user_id, $this->dismiss_name, $user_dismissed, $global = false );
}
echo "\n" . '' . "\n";
echo '' . "\n";
echo $nag_html . "\n";
echo $msg_html . "\n";
echo '' . "\n";
if ( ! empty( $this->p->debug->enabled ) ) {
$this->p->debug->log( $this->plugin_id . ' admin notices end' );
}
}
public function ajax_get_notices_json() {
$doing_ajax = SucomUtilWP::doing_ajax();
if ( ! $doing_ajax ) { // Just in case.
return;
} elseif ( SucomUtil::get_const( 'DOING_AUTOSAVE' ) ) {
die( -1 );
}
/*
* Check nonce value before using $_REQUEST.
*/
check_ajax_referer( $this->nonce_name, '_ajax_nonce', $die = true );
$notice_types = $this->all_types;
if ( ! empty( $_REQUEST[ '_notice_types' ] ) ) {
if ( is_array( $_REQUEST[ '_notice_types' ] ) ) {
$notice_types = $_REQUEST[ '_notice_types' ];
} else $notice_types = explode( ',', $_REQUEST[ '_notice_types' ] );
}
if ( ! empty( $_REQUEST[ '_exclude_types' ] ) ) {
if ( is_array( $_REQUEST[ '_exclude_types' ] ) ) {
$exclude_types = $_REQUEST[ '_exclude_types' ];
} else $exclude_types = explode( ',', $_REQUEST[ '_exclude_types' ] );
$notice_types = array_diff( $notice_types, $exclude_types );
}
if ( empty( $notice_types ) ) { // Just in case.
die( -1 );
}
$user_id = get_current_user_id(); // Always returns an integer.
$user_dismissed = $user_id ? get_user_option( $this->dismiss_name, $user_id ) : false; // Note that $user_id is the second argument.
$update_dismissed = false;
$json_notices = array();
$ajax_context = empty( $_REQUEST[ 'context' ] ) ? '' : $_REQUEST[ 'context' ]; // 'block_editor' or 'toolbar_notices'
$this->has_shown = true;
$this->load_notice_cache( $user_id ); // Read and merge notices from transient cache.
$this->load_update_notices( $user_id );
/*
* Loop through all the msg types and show them all.
*/
foreach ( $notice_types as $msg_type ) {
if ( ! isset( $this->notice_cache[ $user_id ][ $msg_type ] ) ) { // Just in case.
continue;
}
foreach ( $this->notice_cache[ $user_id ][ $msg_type ] as $msg_key => $payload ) {
$this->unload_notice_cache( $user_id, $msg_type, $msg_key );
if ( empty( $payload[ 'msg_text' ] ) ) { // Nothing to show.
continue;
}
/*
* Make sure the notice has not exceeded its TTL.
*
* A 'notice_ttl' value of 0 disables the notice message expiration.
*/
if ( ! empty( $payload[ 'notice_time' ] ) && ! empty( $payload[ 'notice_ttl' ] ) ) {
if ( time() > $payload[ 'notice_time' ] + $payload[ 'notice_ttl' ] ) {
continue;
}
}
if ( ! empty( $payload[ 'dismiss_time' ] ) ) { // True or seconds greater than 0.
/*
* Check for automatically hidden errors and/or warnings.
*/
if ( ! empty( $payload[ 'notice_key' ] ) && isset( $user_dismissed[ $payload[ 'notice_key' ] ] ) ) {
$current_time = time();
$dismiss_time = $user_dismissed[ $payload[ 'notice_key' ] ]; // Get time for key.
if ( empty( $dismiss_time ) || $dismiss_time > $current_time ) { // 0 or time in future.
$payload[ 'hidden' ] = true;
} else { // Dismiss has expired.
unset( $user_dismissed[ $payload[ 'notice_key' ] ] );
$update_dismissed = true; // Update the user meta when done.
}
}
}
$payload[ 'msg_html' ] = $this->get_notice_html( $msg_type, $payload, $notice_alt = true );
$json_notices[ $msg_type ][ $msg_key ] = $payload;
}
}
/*
* Don't save unless we've changed something.
*/
if ( $user_id && $update_dismissed ) {
if ( empty( $user_dismissed ) ) {
delete_user_option( $user_id, $this->dismiss_name, $global = false );
} else update_user_option( $user_id, $this->dismiss_name, $user_dismissed, $global = false );
}
$json_encoded = wp_json_encode( $json_notices );
die( $json_encoded );
}
public function ajax_dismiss_notice() {
$doing_ajax = SucomUtilWP::doing_ajax();
if ( ! $doing_ajax ) { // Just in case.
return;
}
$user_id = get_current_user_id(); // Always returns an integer.
$dismiss_info = array();
if ( empty( $user_id ) || ! current_user_can( 'edit_user', $user_id ) ) {
die( -1 );
}
check_ajax_referer( __FILE__, 'dismiss_nonce', $die = true );
/*
* Quick sanitation of input values.
*/
foreach ( array( 'notice_key', 'dismiss_time' ) as $key ) {
$dismiss_info[ $key ] = sanitize_text_field( filter_input( INPUT_POST, $key ) );
}
if ( empty( $dismiss_info[ 'notice_key' ] ) ) { // Just in case.
die( -1 );
}
$user_dismissed = get_user_option( $this->dismiss_name, $user_id ); // Note that $user_id is the second argument.
if ( ! is_array( $user_dismissed ) ) {
$user_dismissed = array();
}
if ( empty( $dismiss_info[ 'dismiss_time' ] ) || ! is_numeric( $dismiss_info[ 'dismiss_time' ] ) ) {
$user_dismissed[ $dismiss_info[ 'notice_key' ] ] = 0;
} else {
$user_dismissed[ $dismiss_info[ 'notice_key' ] ] = time() + $dismiss_info[ 'dismiss_time' ];
}
update_user_option( $user_id, $this->dismiss_name, $user_dismissed, $global = false );
die( '1' );
}
/*
* Returns false or an array of notice types to include in the toolbar menu.
*
* Called by WpssoScript->get_admin_page_script_data() to define the types shown for ajax calls.
*/
public function get_toolbar_types() {
/*
* is_admin_bar_showing() should always return true in the back-end for a standard request (ie. not xmlrpc, ajax, iframe).
*/
$toolbar_types = is_admin_bar_showing() ? $this->toolbar_types : false;
$toolbar_types = apply_filters( 'sucom_toolbar_notice_types', $toolbar_types );
return $toolbar_types;
}
public function admin_footer_script() {
if ( ! empty( $this->p->debug->enabled ) ) {
$this->p->debug->mark();
}
echo $this->get_notice_script();
}
/*
* Called by the WordPress 'shutdown' action. Save notices for all user IDs in the notice cache.
*/
public function shutdown_notice_cache() {
if ( ! empty( $this->p->debug->enabled ) ) {
$this->p->debug->mark();
}
foreach ( $this->notice_cache as $user_id => $msg_types ) {
$this->update_notice_cache( $user_id );
}
}
/*
* Set property values for text domain, notice label, etc.
*/
private function set_config( $plugin = null, $plugin_id = null, $text_domain = null, $label_transl = false ) {
if ( null !== $plugin ) {
$this->p =& $plugin;
if ( ! empty( $this->p->debug->enabled ) ) {
$this->p->debug->mark();
}
}
/*
* Set the lower and upper case acronyms.
*/
if ( null !== $plugin_id ) {
$this->plugin_id = $plugin_id;
} elseif ( ! empty( $this->p->id ) ) {
$this->plugin_id = $this->p->id;
}
$this->plugin_ucid = strtoupper( $this->plugin_id );
/*
* Set the text domain.
*/
$this->set_textdomain( $text_domain );
/*
* Set the dismiss key name.
*/
if ( defined( $this->plugin_ucid . '_DISMISS_NAME' ) ) {
$this->dismiss_name = constant( $this->plugin_ucid . '_DISMISS_NAME' );
} else {
$this->dismiss_name = $this->plugin_id . '_dismissed';
}
/*
* Set the notices key name.
*/
if ( defined( $this->plugin_ucid . '_NOTICES_NAME' ) ) {
$this->notices_name = constant( $this->plugin_ucid . '_NOTICES_NAME' );
} else {
$this->notices_name = $this->plugin_id . '_notices';
}
/*
* Set the nonce key name.
*/
if ( defined( $this->plugin_ucid . '_NONCE_NAME' ) ) {
$this->nonce_name = constant( $this->plugin_ucid . '_NONCE_NAME' );
} elseif ( defined( 'NONCE_KEY' ) ) {
$this->nonce_name = NONCE_KEY;
}
/*
* Set the translated notice label.
*/
$this->set_label_transl( $label_transl );
}
/*
* Add WordPress action and filter callbacks.
*/
private function add_wp_callbacks() {
static $do_once = null;
if ( $do_once ) return; // Stop here.
$do_once = true;
$doing_cron = defined( 'DOING_CRON' ) ? DOING_CRON : false;
if ( is_admin() ) {
add_action( 'wp_ajax_' . $this->plugin_id . '_dismiss_notice', array( $this, 'ajax_dismiss_notice' ) );
add_action( 'wp_ajax_' . $this->plugin_id . '_get_notices_json', array( $this, 'ajax_get_notices_json' ) );
/*
* The 'in_admin_header' action executes at the beginning of the content section in an admin page.
*/
add_action( 'in_admin_header', array( $this, 'admin_header_notices' ), PHP_INT_MAX );
add_action( 'admin_footer', array( $this, 'admin_footer_script' ) );
}
if ( is_admin() || $doing_cron ) {
add_action( 'shutdown', array( $this, 'shutdown_notice_cache' ), -2000, 0 );
}
}
/*
* $msg_text can be a single text string, or an array of text strings.
*/
private function add_notice( $msg_type, $msg_text, $user_id = null, $notice_key = false, $dismiss_time = false, $payload = array() ) {
if ( ! $this->enabled ) { // Just in case.
return false;
}
/*
* If $msg_text is an array of text strings, implode the array into a single text string.
*/
$msg_text = is_array( $msg_text ) ? implode( $glue = ' ', $msg_text ) : (string) $msg_text;
$msg_text = trim( $msg_text );
if ( empty( $msg_type ) || empty( $msg_text ) ) {
return false;
}
$cur_uid = get_current_user_id(); // Always returns an integer.
$user_id = is_numeric( $user_id ) ? (int) $user_id : $cur_uid; // $user_id can be true, false, null, or numeric.
if ( empty( $user_id ) ) { // User ID is 0 (cron user, for example).
return false;
}
$payload[ 'user_id' ] = $user_id;
$payload[ 'notice_label' ] = isset( $payload[ 'notice_label' ] ) ? $payload[ 'notice_label' ] : $this->label_transl;
$payload[ 'notice_key' ] = empty( $notice_key ) ? false : sanitize_key( $notice_key );
$payload[ 'notice_time' ] = time();
/*
* 0 disables notice expiration.
*/
$payload[ 'notice_ttl' ] = isset( $payload[ 'notice_ttl' ] ) ? (int) $payload[ 'notice_ttl' ] : $this->default_ttl;
$payload[ 'dismiss_time' ] = false;
$payload[ 'dismiss_diff' ] = isset( $payload[ 'dismiss_diff' ] ) ? $payload[ 'dismiss_diff' ] : null;
/*
* Add dismiss text for dismiss button and notice message.
*/
if ( $this->can_dismiss() ) {
$payload[ 'dismiss_time' ] = $dismiss_time; // Maybe true, false, 0, or seconds greater than 0.
if ( null === $payload[ 'dismiss_diff' ] ) { // Has not been provided, so set a default value.
$dismiss_suffix_msg = false;
if ( true === $payload[ 'dismiss_time' ] ) { // True.
$payload[ 'dismiss_diff' ] = __( 'Forever', $this->text_domain );
$dismiss_suffix_msg = __( 'This notice can be dismissed permanently.', $this->text_domain );
} elseif ( empty( $payload[ 'dismiss_time' ] ) ) { // False or 0 seconds.
$payload[ 'dismiss_time' ] = false;
$payload[ 'dismiss_diff' ] = false;
} elseif ( is_numeric( $payload[ 'dismiss_time' ] ) ) { // Seconds greater than 0.
$payload[ 'dismiss_diff' ] = human_time_diff( 0, $payload[ 'dismiss_time' ] );
$dismiss_suffix_msg = __( 'This notice can be dismissed for %s.', $this->text_domain );
}
if ( ! empty( $payload[ 'dismiss_diff' ] ) && $dismiss_suffix_msg ) {
$msg_close_div = '';
if ( '' === substr( $msg_text, -6 ) ) {
$msg_text = substr( $msg_text, 0, -6 );
$msg_close_div = '';
}
$msg_add_p = '' === substr( $msg_text, -4 ) ? true : false;
$msg_text .= $msg_add_p || $msg_close_div ? '' : ' '; $msg_text .= sprintf( $dismiss_suffix_msg, $payload[ 'dismiss_diff' ] ); $msg_text .= $msg_add_p || $msg_close_div ? '
' : ''; $msg_text .= $msg_close_div; } } } /* * Maybe add a reference URL at the end. */ $msg_text .= $this->get_ref_url_html(); $payload[ 'msg_text' ] = preg_replace( '/(.*?)/Us', ' ', $msg_text ); $payload[ 'msg_spoken' ] = preg_replace( '/(.*?)/Us', ' ', $msg_text ); $payload[ 'msg_spoken' ] = SucomUtil::decode_html( SucomUtil::strip_html( $payload[ 'msg_spoken' ] ) ); $msg_key = empty( $payload[ 'notice_key' ] ) ? sanitize_key( $payload[ 'msg_spoken' ] ) : $payload[ 'notice_key' ]; $this->notice_cache[ $user_id ][ $msg_type ][ $msg_key ] = $payload; /* * Save the notice cache now. */ if ( $cur_uid !== $user_id ) { $this->update_notice_cache( $user_id ); } } private function unload_notice_cache( $user_id, $msg_type, $msg_key ) { unset( $this->notice_cache[ $user_id ][ $msg_type ][ $msg_key ] ); if ( empty( $this->notice_cache[ $user_id ][ $msg_type ] ) ) { unset( $this->notice_cache[ $user_id ][ $msg_type ] ); } $this->notice_noload[ $user_id ][ $msg_type ][ $msg_key ] = true; } /* * Merge notice cache with saved notices (without overwriting). */ private function load_notice_cache( $user_id = null ) { $cur_uid = get_current_user_id(); // Always returns an integer. $user_id = is_numeric( $user_id ) ? (int) $user_id : $cur_uid; // $user_id can be true, false, null, or numeric. $result = $this->get_notice_cache( $user_id ); // Always returns an array. if ( ! empty( $result ) ) { foreach ( $this->all_types as $msg_type ) { if ( ! empty( $result[ $msg_type ] ) ) { foreach ( $result[ $msg_type ] as $msg_key => $payload ) { if ( ! isset( $this->notice_cache[ $user_id ][ $msg_type ][ $msg_key ] ) && ! isset( $this->notice_noload[ $user_id ][ $msg_type ][ $msg_key ] ) ) { $this->notice_cache[ $user_id ][ $msg_type ][ $msg_key ] = $payload; $this->notice_noload[ $user_id ][ $msg_type ][ $msg_key ] = true; } } } } } } private function load_update_notices( $user_id ) { if ( ! class_exists( 'SucomUpdate' ) ) { return; } elseif ( empty( $this->p->cf[ 'plugin' ] ) ) { // Just in case. return; } foreach ( $this->p->cf[ 'plugin' ] as $ext => $info ) { if ( SucomUpdate::is_configured( $ext ) ) { foreach ( array( 'inf', 'err' ) as $type ) { if ( $msg = SucomUpdate::get_umsg( $ext, $type ) ) { $msg_text = preg_replace( '/(.*?)/Us', ' ', $msg ); $msg_spoken = preg_replace( '/(.*?)/Us', ' ', $msg ); $msg_spoken = SucomUtil::decode_html( SucomUtil::strip_html( $msg_spoken ) ); $msg_key = sanitize_key( $msg_spoken ); $this->notice_cache[ $user_id ][ $type ][ $msg_key ] = array( 'notice_label' => $this->label_transl, 'notice_key' => $msg_key, 'msg_text' => $msg_text, 'msg_spoken' => $msg_spoken, ); } } } } } private function update_notice_cache( $user_id = null ) { $cur_uid = get_current_user_id(); // Always returns an integer. $user_id = is_numeric( $user_id ) ? (int) $user_id : $cur_uid; // $user_id can be true, false, null, or numeric. $update = true; $result = false; if ( ! empty( $user_id ) ) { // Just in case. if ( $cur_uid !== $user_id ) { $this->load_notice_cache( $user_id ); // Read and merge notices from transient cache. } $result = update_user_option( $user_id, $this->notices_name, $this->notice_cache[ $user_id ], $global = false ); } $this->notice_cache[ $user_id ] = array(); return $result; } private function get_notice_cache( $user_id = null ) { $cur_uid = get_current_user_id(); // Always returns an integer. $user_id = is_numeric( $user_id ) ? (int) $user_id : $cur_uid; // $user_id can be true, false, null, or numeric. $result = array(); if ( ! empty( $user_id ) ) { // Nothing to do. $result = get_user_option( $this->notices_name, $user_id ); if ( ! is_array( $result ) ) { // Always return an array. $result = array(); } } return $result; } /* * Use a reference for the $payload variable so we can modify the 'msg_text' element and remove text that should be * shown only once. */ private function get_notice_html( $msg_type, array &$payload, $notice_alt = false ) { /* * Add an 'inline' class in toolbar notices to prevent WordPress from moving the notice. * * See wordpress/wp-admin/js/common.js:1083 */ $notice_type = $notice_alt ? 'notice notice-alt inline' : 'notice'; $notice_display = 'block'; switch ( $msg_type ) { case 'nag': $payload[ 'notice_label' ] = ''; // No label for nag notices. $msg_type = 'nag'; $css_class = 'update-nag'; break; case 'err': case 'error': $msg_type = 'err'; $css_class = $notice_type . ' notice-error error'; break; case 'warn': case 'warning': $msg_type = 'warn'; $css_class = $notice_type . ' notice-warning'; break; case 'inf': case 'info': $msg_type = 'inf'; $css_class = $notice_type . ' notice-info'; break; case 'upd': case 'updated': $msg_type = 'upd'; $css_class = $notice_type . ' notice-success updated'; break; default: // Unknown $msg_type. $msg_type = 'unknown'; $css_class = $notice_type; break; } $css_id_attr = empty( $payload[ 'notice_key' ] ) ? '' : ' id="' . $msg_type . '-' . $payload[ 'notice_key' ] . '"'; $is_dismissible = empty( $payload[ 'dismiss_time' ] ) ? false : true; $data_attr = ''; if ( $is_dismissible ) { $data_attr .= ' data-notice-key="' . ( isset( $payload[ 'notice_key' ] ) ? esc_attr( $payload[ 'notice_key' ] ) : '' ). '"'; $data_attr .= ' data-dismiss-time="' . ( isset( $payload[ 'dismiss_time' ] ) && is_numeric( $payload[ 'dismiss_time' ] ) ? esc_attr( $payload[ 'dismiss_time' ] ) : 0 ) . '"'; $data_attr .= ' data-dismiss-nonce="' . wp_create_nonce( __FILE__ ) . '"'; } $style_attr = ' style="' . ( empty( $payload[ 'style' ] ) ? '' : $payload[ 'style' ] ) . ( empty( $payload[ 'hidden' ] ) ? 'display:' . $notice_display . ' !important;' : 'display:none !important;' ) . '"'; $msg_html = '