Notices.php
12.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<?php if ( ! defined( 'ABSPATH' ) ) exit;
/**
* NF_Notices Class
*
* Can be simply used be adding another line into the nf_admin_notices() function under notices.php
*
* Can be extended to create more advanced notices to include triggered events
*
* @since 2.9
*/
class NF_Admin_Notices
{
// Highlander the instance
static $instance;
public static function instance()
{
if ( ! isset( self::$instance ) ) {
self::$instance = new NF_Notices();
}
return self::$instance;
}
public $notice_spam = 0;
public $notice_spam_max = 1;
// Basic actions to run
public function __construct(){
// Runs the admin notice ignore function incase a dismiss button has been clicked
add_action( 'admin_init', array( $this, 'admin_notice_ignore' ) );
// Runs the admin notice temp ignore function incase a temp dismiss link has been clicked
add_action( 'admin_init', array( $this, 'admin_notice_temp_ignore' ) );
}
// Checks to ensure notices aren't disabled and the user has the correct permissions.
public function nf_admin_notice() {
$nf_settings = get_option( 'ninja_forms_settings' );
if ( ! isset( $nf_settings[ 'disable_admin_notices' ] ) || ( isset( $nf_settings[ 'disable_admin_notices' ] ) && $nf_settings[ 'disable_admin_notices' ] == 0 ) ){
if ( current_user_can( apply_filters( 'ninja_forms_admin_parent_menu_capabilities', 'manage_options' ) ) ) {
return true;
}
}
return false;
}
// Primary notice function that can be called from an outside function sending necessary variables
public function admin_notice( $admin_notices ) {
// Check options
if ( ! $this->nf_admin_notice() ) {
return false;
}
foreach ( $admin_notices as $slug => $admin_notice ) {
if ( isset ( $admin_notice[ 'ignore_spam' ] ) && true == $admin_notice[ 'ignore_spam' ] ) {
$ignore_spam = true;
} else {
$ignore_spam = false;
}
// Call for spam protection
if ( ! $ignore_spam && $this->anti_notice_spam() ) {
continue;
}
// Check for proper page to display on
if ( isset( $admin_notices[ $slug ][ 'pages' ] ) && is_array( $admin_notices[ $slug ][ 'pages' ] )
|| isset( $admin_notices[ $slug ][ 'blacklist' ] ) && is_array( $admin_notices[ $slug ][ 'blacklist' ] )
) {
if( ( isset( $admin_notices[ $slug ][ 'blacklist' ] ) && $this->admin_notice_pages_blacklist( $admin_notices[ $slug ][ 'blacklist' ] ) )
|| ( isset( $admin_notices[ $slug ][ 'pages' ] ) && ! $this->admin_notice_pages( $admin_notices[ $slug ][ 'pages' ] ) )
) {
continue;
}
}
// Check for required fields
if ( ! $this->required_fields( $admin_notices[ $slug ] ) ) {
// Get the current date then set start date to either passed value or current date value and add interval
$current_date = current_time( "n/j/Y" );
$start = ( isset( $admin_notices[ $slug ][ 'start' ] ) ? $admin_notices[ $slug ][ 'start' ] : $current_date );
$start = date( "n/j/Y", strtotime( $start ) );
$date_array = explode( '/', $start );
$interval = ( isset( $admin_notices[ $slug ][ 'int' ] ) ? $admin_notices[ $slug ][ 'int' ] : 0 );
$date_array[1] += $interval;
$start = date( "n/j/Y", mktime( 0, 0, 0, $date_array[0], $date_array[1], $date_array[2] ) );
// This is the main notices storage option
$admin_notices_option = get_option( 'nf_admin_notice', array() );
// Check if the message is already stored and if so just grab the key otherwise store the message and its associated date information
if ( ! array_key_exists( $slug, $admin_notices_option ) ) {
$admin_notices_option[ $slug ][ 'start' ] = $start;
$admin_notices_option[ $slug ][ 'int' ] = $interval;
update_option( 'nf_admin_notice', $admin_notices_option );
}
// Sanity check to ensure we have accurate information
// New date information will not overwrite old date information
$admin_display_check = ( isset( $admin_notices_option[ $slug ][ 'dismissed' ] ) ? $admin_notices_option[ $slug ][ 'dismissed'] : 0 );
$admin_display_start = ( isset( $admin_notices_option[ $slug ][ 'start' ] ) ? $admin_notices_option[ $slug ][ 'start'] : $start );
$admin_display_interval = ( isset( $admin_notices_option[ $slug ][ 'int' ] ) ? $admin_notices_option[ $slug ][ 'int'] : $interval );
$admin_display_msg = ( isset( $admin_notices[ $slug ][ 'msg' ] ) ? $admin_notices[ $slug ][ 'msg'] : '' );
$admin_display_title = ( isset( $admin_notices[ $slug ][ 'title' ] ) ? $admin_notices[ $slug ][ 'title'] : '' );
$admin_display_link = ( isset( $admin_notices[ $slug ][ 'link' ] ) ? $admin_notices[ $slug ][ 'link' ] : '' );
$admin_can_dismiss = ( isset( $admin_notices[ $slug ][ 'dismiss' ] ) ? $admin_notices[ $slug ][ 'dismiss' ] : 1 );
$output_css = false;
// Ensure the notice hasn't been hidden and that the current date is after the start date
if ( $admin_display_check == 0 && strtotime( $admin_display_start ) <= strtotime( $current_date ) ) {
// Get remaining query string
$query_str = esc_url( add_query_arg( 'nf_admin_notice_ignore', $slug ) );
// Admin notice display output
echo '<div class="update-nag nf-admin-notice">';
echo '<div class="nf-notice-logo"></div>';
echo '<div class="nf-notice-container">';
echo '<div class="nf-notice-title">';
echo esc_html( $admin_display_title );
echo '</div>';
echo ' <p class="nf-notice-body">';
echo $admin_display_msg;
echo ' </p>';
echo '<ul class="nf-notice-links">
' . $admin_display_link . '
</ul>';
echo '</div>';
if ( $admin_can_dismiss ) {
echo '<a href="' . wp_nonce_url( esc_attr( $query_str ) ) . '" class="dashicons dashicons-dismiss"></a>';
}
echo '</div>';
$this->notice_spam += 1;
$output_css = true;
}
if ( $output_css ) {
wp_enqueue_style( 'nf-admin-notices', Ninja_Forms::$url .'assets/css/admin-notices.css?nf_ver=' . Ninja_Forms::VERSION );
}
}
}
// die( 'done looping' );
}
// Spam protection check
public function anti_notice_spam() {
if ( $this->notice_spam >= $this->notice_spam_max ) {
return true;
}
return false;
}
// Ignore function that gets ran at admin init to ensure any messages that were dismissed get marked
public function admin_notice_ignore() {
// If user clicks to ignore the notice, update the option to not show it again
if ( isset($_GET['nf_admin_notice_ignore']) && current_user_can( apply_filters( 'ninja_forms_admin_parent_menu_capabilities', 'manage_options' ) ) ) {
if ( ! check_admin_referer() ) {
$query_str = remove_query_arg( array( 'nf_admin_notice_ignore', '_wpnonce' ) );
wp_safe_redirect( $query_str );
exit;
}
$admin_notices_option = get_option( 'nf_admin_notice', array() );
$admin_notices_option[ WPN_Helper::sanitize_text_field($_GET[ 'nf_admin_notice_ignore' ]) ][ 'dismissed' ] = 1;
update_option( 'nf_admin_notice', $admin_notices_option );
$query_str = remove_query_arg( array( 'nf_admin_notice_ignore', '_wpnonce' ) );
wp_safe_redirect( $query_str );
exit;
}
}
// Temp Ignore function that gets ran at admin init to ensure any messages that were temp dismissed get their start date changed
public function admin_notice_temp_ignore() {
// If user clicks to temp ignore the notice, update the option to change the start date - default interval of 14 days
if ( isset($_GET['nf_admin_notice_temp_ignore']) && current_user_can( apply_filters( 'ninja_forms_admin_parent_menu_capabilities', 'manage_options' ) ) ) {
$admin_notices_option = get_option( 'nf_admin_notice', array() );
$current_date = current_time( "n/j/Y" );
$date_array = explode( '/', $current_date );
$interval = ( isset( $_GET[ 'nf_int' ] ) ? intval($_GET[ 'nf_int' ]) : 14 );
$date_array[1] += $interval;
$new_start = date( "n/j/Y", mktime( 0, 0, 0, $date_array[0], $date_array[1], $date_array[2] ) );
$admin_notices_option[ WPN_Helper::sanitize_text_field($_GET[ 'nf_admin_notice_temp_ignore' ]) ][ 'start' ] = $new_start;
$admin_notices_option[ WPN_Helper::sanitize_text_field($_GET[ 'nf_admin_notice_temp_ignore' ]) ][ 'dismissed' ] = 0;
update_option( 'nf_admin_notice', $admin_notices_option );
$query_str = remove_query_arg( array( 'nf_admin_notice_temp_ignore', 'nf_int' ) );
wp_redirect( $query_str );
exit;
}
}
public function admin_notice_pages_blacklist( $pages ) {
foreach( $pages as $key => $page ) {
if ( is_array( $page ) ) {
if ( isset( $_GET[ 'page' ] ) && $_GET[ 'page'] == $page[0] && isset( $_GET[ 'tab' ] ) && $_GET[ 'tab' ] == $page[1] ) {
return true;
}
} else {
if ( get_current_screen()->id === $page ) {
return true;
}
if ( isset( $_GET[ 'page' ] ) && $_GET[ 'page'] == $page ) {
return true;
}
}
}
return false;
}
// Page check function - This should be called from class extensions if the notice should only show on specific admin pages
// Expects an array in the form of IE: array( 'dashboard', 'ninja-forms', array( 'ninja-forms', 'builder' ) )
// Function accepts dashboard as a special check and also whatever is passed to page or tab as parameters
// The above example will display on dashboard and all of the pages that have page=ninja-forms and any page=ninja-forms&tab=builder which is redundant in the example
public function admin_notice_pages( $pages ) {
foreach( $pages as $key => $page ) {
if ( is_array( $page ) ) {
if ( isset( $_GET[ 'page' ] ) && $_GET[ 'page'] == $page[0] && isset( $_GET[ 'tab' ] ) && $_GET[ 'tab' ] == $page[1] ) {
return true;
}
} else {
if ( $page == 'all' ) {
return true;
}
if ( get_current_screen()->id === $page ) {
return true;
}
if ( isset( $_GET[ 'page' ] ) && $_GET[ 'page'] == $page ) {
return true;
}
}
}
return false;
}
// Required fields check
public function required_fields( $fields ) {
if ( ! isset( $fields[ 'msg' ] ) || ( isset( $fields[ 'msg' ] ) && empty( $fields[ 'msg' ] ) ) ) {
return true;
}
if ( ! isset( $fields[ 'title' ] ) || ( isset( $fields[ 'title' ] ) && empty( $fields[ 'title' ] ) ) ) {
return true;
}
return false;
}
// Special parameters function that is to be used in any extension of this class
public function special_parameters( $admin_notices ) {
// Intentionally left blank
}
}