<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Dismissible admin notices.

[5] Fix | Delete

*

[6] Fix | Delete

* @since 1.6.7.1

[7] Fix | Delete

*

[8] Fix | Delete

* @example Dismissible - global:

[9] Fix | Delete

* \WPForms\Admin\Notice::error(

[10] Fix | Delete

* 'Fatal error!',

[11] Fix | Delete

* [

[12] Fix | Delete

* 'dismiss' => \WPForms\Admin\Notice::DISMISS_GLOBAL,

[13] Fix | Delete

* 'slug' => 'fatal_error_3678975',

[14] Fix | Delete

* ]

[15] Fix | Delete

* );

[16] Fix | Delete

*

[17] Fix | Delete

* @example Dismissible - per user:

[18] Fix | Delete

* \WPForms\Admin\Notice::warning(

[19] Fix | Delete

* 'Do something please.',

[20] Fix | Delete

* [

[21] Fix | Delete

* 'dismiss' => \WPForms\Admin\Notice::DISMISS_USER,

[22] Fix | Delete

* 'slug' => 'do_something_1238943',

[23] Fix | Delete

* ]

[24] Fix | Delete

* );

[25] Fix | Delete

*

[26] Fix | Delete

* @example Dismissible - global, add custom class to output and disable auto paragraph in text:

[27] Fix | Delete

* \WPForms\Admin\Notice::error(

[28] Fix | Delete

* 'Fatal error!',

[29] Fix | Delete

* [

[30] Fix | Delete

* 'dismiss' => \WPForms\Admin\Notice::DISMISS_GLOBAL,

[31] Fix | Delete

* 'slug' => 'fatal_error_348975',

[32] Fix | Delete

* 'autop' => false,

[33] Fix | Delete

* 'class' => 'some-additional-class',

[34] Fix | Delete

* ]

[35] Fix | Delete

* );

[36] Fix | Delete

*

[37] Fix | Delete

* @example Not dismissible:

[38] Fix | Delete

* \WPForms\Admin\Notice::success( 'Everything is good!' );

[39] Fix | Delete

*/

[40] Fix | Delete

class Notice {

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Not dismissible.

[44] Fix | Delete

*

[45] Fix | Delete

* Constant attended to use as the value of the $args['dismiss'] argument.

[46] Fix | Delete

* DISMISS_NONE means that the notice is not dismissible.

[47] Fix | Delete

*

[48] Fix | Delete

* @since 1.6.7.1

[49] Fix | Delete

*/

[50] Fix | Delete

const DISMISS_NONE = 0;

[51] Fix | Delete

[52] Fix | Delete

/**

[53] Fix | Delete

* Dismissible global.

[54] Fix | Delete

*

[55] Fix | Delete

* Constant attended to use as the value of the $args['dismiss'] argument.

[56] Fix | Delete

* DISMISS_GLOBAL means that the notice will have the dismiss button, and after clicking this button, the notice will be dismissed for all users.

[57] Fix | Delete

*

[58] Fix | Delete

* @since 1.6.7.1

[59] Fix | Delete

*/

[60] Fix | Delete

const DISMISS_GLOBAL = 1;

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Dismissible per user.

[64] Fix | Delete

*

[65] Fix | Delete

* Constant attended to use as the value of the $args['dismiss'] argument.

[66] Fix | Delete

* DISMISS_USER means that the notice will have the dismiss button, and after clicking this button, the notice will be dismissed only for the current user..

[67] Fix | Delete

*

[68] Fix | Delete

* @since 1.6.7.1

[69] Fix | Delete

*/

[70] Fix | Delete

const DISMISS_USER = 2;

[71] Fix | Delete

[72] Fix | Delete

/**

[73] Fix | Delete

* Order of notices by type.

[74] Fix | Delete

*

[75] Fix | Delete

* @since 1.9.1

[76] Fix | Delete

*/

[77] Fix | Delete

const ORDER = [

[78] Fix | Delete

'error',

[79] Fix | Delete

'warning',

[80] Fix | Delete

'info',

[81] Fix | Delete

'success',

[82] Fix | Delete

];

[83] Fix | Delete

[84] Fix | Delete

/**

[85] Fix | Delete

* Added notices.

[86] Fix | Delete

*

[87] Fix | Delete

* @since 1.6.7.1

[88] Fix | Delete

*

[89] Fix | Delete

* @var array

[90] Fix | Delete

*/

[91] Fix | Delete

private $notices = [];

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Init.

[95] Fix | Delete

*

[96] Fix | Delete

* @since 1.6.7.1

[97] Fix | Delete

*/

[98] Fix | Delete

public function init() {

[99] Fix | Delete

[100] Fix | Delete

$this->hooks();

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

/**

[104] Fix | Delete

* Hooks.

[105] Fix | Delete

*

[106] Fix | Delete

* @since 1.6.7.1

[107] Fix | Delete

*/

[108] Fix | Delete

public function hooks() {

[109] Fix | Delete

[110] Fix | Delete

add_action( 'admin_notices', [ $this, 'display' ], PHP_INT_MAX );

[111] Fix | Delete

add_action( 'wp_ajax_wpforms_notice_dismiss', [ $this, 'dismiss_ajax' ] );

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

/**

[115] Fix | Delete

* Enqueue assets.

[116] Fix | Delete

*

[117] Fix | Delete

* @since 1.6.7.1

[118] Fix | Delete

*/

[119] Fix | Delete

private function enqueues() {

[120] Fix | Delete

[121] Fix | Delete

$min = wpforms_get_min_suffix();

[122] Fix | Delete

[123] Fix | Delete

wp_enqueue_script(

[124] Fix | Delete

'wpforms-admin-notices',

[125] Fix | Delete

WPFORMS_PLUGIN_URL . "assets/js/admin/notices{$min}.js",

[126] Fix | Delete

[ 'jquery' ],

[127] Fix | Delete

WPFORMS_VERSION,

[128] Fix | Delete

true

[129] Fix | Delete

);

[130] Fix | Delete

[131] Fix | Delete

wp_localize_script(

[132] Fix | Delete

'wpforms-admin-notices',

[133] Fix | Delete

'wpforms_admin_notices',

[134] Fix | Delete

[

[135] Fix | Delete

'ajax_url' => admin_url( 'admin-ajax.php' ),

[136] Fix | Delete

'nonce' => wp_create_nonce( 'wpforms-admin' ),

[137] Fix | Delete

]

[138] Fix | Delete

);

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

/**

[142] Fix | Delete

* Display the notices.

[143] Fix | Delete

*

[144] Fix | Delete

* @since 1.6.7.1

[145] Fix | Delete

*/

[146] Fix | Delete

public function display() {

[147] Fix | Delete

[148] Fix | Delete

$dismissed_notices = get_user_meta( get_current_user_id(), 'wpforms_admin_notices', true );

[149] Fix | Delete

$dismissed_notices = is_array( $dismissed_notices ) ? $dismissed_notices : [];

[150] Fix | Delete

$dismissed_notices = array_merge( $dismissed_notices, (array) get_option( 'wpforms_admin_notices', [] ) );

[151] Fix | Delete

$dismissed_notices = array_filter( wp_list_pluck( $dismissed_notices, 'dismissed' ) );

[152] Fix | Delete

$this->notices = array_diff_key( $this->notices, $dismissed_notices );

[153] Fix | Delete

[154] Fix | Delete

$output = implode( '', array_column( $this->sort_notices(), 'data' ) );

[155] Fix | Delete

[156] Fix | Delete

echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

[157] Fix | Delete

[158] Fix | Delete

// Enqueue script only when it's needed.

[159] Fix | Delete

if ( strpos( $output, 'is-dismissible' ) !== false ) {

[160] Fix | Delete

$this->enqueues();

[161] Fix | Delete

}

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

/**

[165] Fix | Delete

* Sort notices by type.

[166] Fix | Delete

*

[167] Fix | Delete

* @since 1.9.1

[168] Fix | Delete

*

[169] Fix | Delete

* @return array Notices.

[170] Fix | Delete

*/

[171] Fix | Delete

private function sort_notices(): array {

[172] Fix | Delete

[173] Fix | Delete

$ordered_notices = [];

[174] Fix | Delete

[175] Fix | Delete

foreach ( self::ORDER as $order ) {

[176] Fix | Delete

foreach ( $this->notices as $key => $notice ) {

[177] Fix | Delete

if ( $notice['type'] === $order ) {

[178] Fix | Delete

$ordered_notices[ $key ] = $notice;

[179] Fix | Delete

[180] Fix | Delete

unset( $this->notices[ $key ] );

[181] Fix | Delete

}

[182] Fix | Delete

}

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

// Notices that are not in the self::ORDER array merged to the end of array.

[186] Fix | Delete

return array_merge( $ordered_notices, $this->notices );

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

/**

[190] Fix | Delete

* Add notice to the registry.

[191] Fix | Delete

*

[192] Fix | Delete

* @since 1.6.7.1

[193] Fix | Delete

*

[194] Fix | Delete

* @param string $message Message to display.

[195] Fix | Delete

* @param string $type Type of the notice. Can be [ '' (default) | 'info' | 'error' | 'success' | 'warning' ].

[196] Fix | Delete

* @param array $args The array of additional arguments. Please see the $defaults array below.

[197] Fix | Delete

*/

[198] Fix | Delete

public static function add( $message, $type = '', $args = [] ) {

[199] Fix | Delete

[200] Fix | Delete

static $uniq_id = 0;

[201] Fix | Delete

[202] Fix | Delete

$defaults = [

[203] Fix | Delete

'dismiss' => self::DISMISS_NONE, // Dismissible level: one of the self::DISMISS_* const. By default notice is not dismissible.

[204] Fix | Delete

'slug' => '', // Slug. Should be unique if dismissible is not equal self::DISMISS_NONE.

[205] Fix | Delete

'autop' => true, // `false` if not needed to pass message through wpautop().

[206] Fix | Delete

'class' => '', // Additional CSS class.

[207] Fix | Delete

];

[208] Fix | Delete

[209] Fix | Delete

$args = wp_parse_args( $args, $defaults );

[210] Fix | Delete

[211] Fix | Delete

$dismissible = (int) $args['dismiss'];

[212] Fix | Delete

$dismissible = $dismissible > self::DISMISS_USER ? self::DISMISS_USER : $dismissible;

[213] Fix | Delete

[214] Fix | Delete

$class = $dismissible > self::DISMISS_NONE ? ' is-dismissible' : '';

[215] Fix | Delete

$global = ( $dismissible === self::DISMISS_GLOBAL ) ? 'global-' : '';

[216] Fix | Delete

$slug = sanitize_key( $args['slug'] );

[217] Fix | Delete

[218] Fix | Delete

++$uniq_id;

[219] Fix | Delete

[220] Fix | Delete

$uniq_id += ( $uniq_id === (int) $slug ) ? 1 : 0;

[221] Fix | Delete

[222] Fix | Delete

$notice = [

[223] Fix | Delete

'type' => $type,

[224] Fix | Delete

];

[225] Fix | Delete

[226] Fix | Delete

$id = 'wpforms-notice-' . $global;

[227] Fix | Delete

$id .= empty( $slug ) ? $uniq_id : $slug;

[228] Fix | Delete

$type = ! empty( $type ) ? 'notice-' . esc_attr( sanitize_key( $type ) ) : '';

[229] Fix | Delete

$class = empty( $args['class'] ) ? $class : $class . ' ' . esc_attr( sanitize_key( $args['class'] ) );

[230] Fix | Delete

$message = $args['autop'] ? wpautop( $message ) : $message;

[231] Fix | Delete

$notice['data'] = sprintf(

[232] Fix | Delete

'<div class="notice wpforms-notice %s%s" id="%s">%s</div>',

[233] Fix | Delete

esc_attr( $type ),

[234] Fix | Delete

esc_attr( $class ),

[235] Fix | Delete

esc_attr( $id ),

[236] Fix | Delete

$message

[237] Fix | Delete

);

[238] Fix | Delete

[239] Fix | Delete

if ( empty( $slug ) ) {

[240] Fix | Delete

wpforms()->obj( 'notice' )->notices[] = $notice;

[241] Fix | Delete

} else {

[242] Fix | Delete

wpforms()->obj( 'notice' )->notices[ $slug ] = $notice;

[243] Fix | Delete

}

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

/**

[247] Fix | Delete

* Add info notice.

[248] Fix | Delete

*

[249] Fix | Delete

* @since 1.6.7.1

[250] Fix | Delete

*

[251] Fix | Delete

* @param string $message Message to display.

[252] Fix | Delete

* @param array $args Array of additional arguments. Details in the self::add() method.

[253] Fix | Delete

*/

[254] Fix | Delete

public static function info( $message, $args = [] ) {

[255] Fix | Delete

[256] Fix | Delete

self::add( $message, 'info', $args );

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete

/**

[260] Fix | Delete

* Add error notice.

[261] Fix | Delete

*

[262] Fix | Delete

* @since 1.6.7.1

[263] Fix | Delete

*

[264] Fix | Delete

* @param string $message Message to display.

[265] Fix | Delete

* @param array $args Array of additional arguments. Details in the self::add() method.

[266] Fix | Delete

*/

[267] Fix | Delete

public static function error( $message, $args = [] ) {

[268] Fix | Delete

[269] Fix | Delete

self::add( $message, 'error', $args );

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

/**

[273] Fix | Delete

* Add success notice.

[274] Fix | Delete

*

[275] Fix | Delete

* @since 1.6.7.1

[276] Fix | Delete

*

[277] Fix | Delete

* @param string $message Message to display.

[278] Fix | Delete

* @param array $args Array of additional arguments. Details in the self::add() method.

[279] Fix | Delete

*/

[280] Fix | Delete

public static function success( $message, $args = [] ) {

[281] Fix | Delete

[282] Fix | Delete

self::add( $message, 'success', $args );

[283] Fix | Delete

}

[284] Fix | Delete

[285] Fix | Delete

/**

[286] Fix | Delete

* Add warning notice.

[287] Fix | Delete

*

[288] Fix | Delete

* @since 1.6.7.1

[289] Fix | Delete

*

[290] Fix | Delete

* @param string $message Message to display.

[291] Fix | Delete

* @param array $args Array of additional arguments. Details in the self::add() method.

[292] Fix | Delete

*/

[293] Fix | Delete

public static function warning( $message, $args = [] ) {

[294] Fix | Delete

[295] Fix | Delete

self::add( $message, 'warning', $args );

[296] Fix | Delete

}

[297] Fix | Delete

[298] Fix | Delete

/**

[299] Fix | Delete

* AJAX routine that updates dismissed notices meta data.

[300] Fix | Delete

*

[301] Fix | Delete

* @since 1.6.7.1

[302] Fix | Delete

*/

[303] Fix | Delete

public function dismiss_ajax() {

[304] Fix | Delete

[305] Fix | Delete

// Run a security check.

[306] Fix | Delete

check_ajax_referer( 'wpforms-admin', 'nonce' );

[307] Fix | Delete

[308] Fix | Delete

// Sanitize POST data.

[309] Fix | Delete

$post = array_map( 'sanitize_key', wp_unslash( $_POST ) );

[310] Fix | Delete

[311] Fix | Delete

// Update notices meta data.

[312] Fix | Delete

if ( strpos( $post['id'], 'global-' ) !== false ) {

[313] Fix | Delete

[314] Fix | Delete

// Check for permissions.

[315] Fix | Delete

if ( ! wpforms_current_user_can() ) {

[316] Fix | Delete

wp_send_json_error();

[317] Fix | Delete

}

[318] Fix | Delete

[319] Fix | Delete

$notices = $this->dismiss_global( $post['id'] );

[320] Fix | Delete

$level = self::DISMISS_GLOBAL;

[321] Fix | Delete

[322] Fix | Delete

} else {

[323] Fix | Delete

[324] Fix | Delete

$notices = $this->dismiss_user( $post['id'] );

[325] Fix | Delete

$level = self::DISMISS_USER;

[326] Fix | Delete

}

[327] Fix | Delete

[328] Fix | Delete

/**

[329] Fix | Delete

* Allows developers to apply additional logic to the dismissing notice process.

[330] Fix | Delete

* Executes after updating option or user meta (according to the notice level).

[331] Fix | Delete

*

[332] Fix | Delete

* @since 1.6.7.1

[333] Fix | Delete

*

[334] Fix | Delete

* @param string $notice_id Notice ID (slug).

[335] Fix | Delete

* @param integer $level Notice level.

[336] Fix | Delete

* @param array $notices Dismissed notices.

[337] Fix | Delete

*/

[338] Fix | Delete

do_action( 'wpforms_admin_notice_dismiss_ajax', $post['id'], $level, $notices );

[339] Fix | Delete

[340] Fix | Delete

if ( ! wpforms_debug() ) {

[341] Fix | Delete

wp_send_json_success();

[342] Fix | Delete

}

[343] Fix | Delete

[344] Fix | Delete

wp_send_json_success(

[345] Fix | Delete

[

[346] Fix | Delete

'id' => $post['id'],

[347] Fix | Delete

'time' => time(),

[348] Fix | Delete

'level' => $level,

[349] Fix | Delete

'notices' => $notices,

[350] Fix | Delete

]

[351] Fix | Delete

);

[352] Fix | Delete

}

[353] Fix | Delete

[354] Fix | Delete

/**

[355] Fix | Delete

* AJAX sub-routine that updates dismissed notices option.

[356] Fix | Delete

*

[357] Fix | Delete

* @since 1.6.7.1

[358] Fix | Delete

*

[359] Fix | Delete

* @param string $id Notice Id.

[360] Fix | Delete

*

[361] Fix | Delete

* @return array Notices.

[362] Fix | Delete

*/

[363] Fix | Delete

private function dismiss_global( $id ) {

[364] Fix | Delete

[365] Fix | Delete

$id = str_replace( 'global-', '', $id );

[366] Fix | Delete

$notices = get_option( 'wpforms_admin_notices', [] );

[367] Fix | Delete

$notices[ $id ] = [

[368] Fix | Delete

'time' => time(),

[369] Fix | Delete

'dismissed' => true,

[370] Fix | Delete

];

[371] Fix | Delete

[372] Fix | Delete

update_option( 'wpforms_admin_notices', $notices, true );

[373] Fix | Delete

[374] Fix | Delete

return $notices;

[375] Fix | Delete

}

[376] Fix | Delete

[377] Fix | Delete

/**

[378] Fix | Delete

* AJAX sub-routine that updates dismissed notices user meta.

[379] Fix | Delete

*

[380] Fix | Delete

* @since 1.6.7.1

[381] Fix | Delete

*

[382] Fix | Delete

* @param string $id Notice Id.

[383] Fix | Delete

*

[384] Fix | Delete

* @return array Notices.

[385] Fix | Delete

*/

[386] Fix | Delete

private function dismiss_user( $id ) {

[387] Fix | Delete

[388] Fix | Delete

$user_id = get_current_user_id();

[389] Fix | Delete

$notices = get_user_meta( $user_id, 'wpforms_admin_notices', true );

[390] Fix | Delete

$notices = ! is_array( $notices ) ? [] : $notices;

[391] Fix | Delete

$notices[ $id ] = [

[392] Fix | Delete

'time' => time(),

[393] Fix | Delete

'dismissed' => true,

[394] Fix | Delete

];

[395] Fix | Delete

[396] Fix | Delete

update_user_meta( $user_id, 'wpforms_admin_notices', $notices );

[397] Fix | Delete

[398] Fix | Delete

return $notices;

[399] Fix | Delete

}

[400] Fix | Delete

}

[401] Fix | Delete

[402] Fix | Delete