Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Plugin notices handler.

[2] Fix | Delete

[3] Fix | Delete

* This class will take care of registering, queuing and showing different

[4] Fix | Delete

* notices across WP pages.

[5] Fix | Delete

[6] Fix | Delete

* @since 2.0

[7] Fix | Delete

* @author Incsub (Joel James)

[8] Fix | Delete

* @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html

[9] Fix | Delete

[10] Fix | Delete

* @package WPMUDEV\Notices

[11] Fix | Delete

* @subpackage Handler

[12] Fix | Delete

[13] Fix | Delete

[14] Fix | Delete

namespace WPMUDEV\Notices;

[15] Fix | Delete

[16] Fix | Delete

// If this file is called directly, abort.

[17] Fix | Delete

defined( 'WPINC' ) || die;

[18] Fix | Delete

[19] Fix | Delete

if ( ! class_exists( __NAMESPACE__ . '\\Handler' ) ) {

[20] Fix | Delete

/**

[21] Fix | Delete

* Class Module

[22] Fix | Delete

[23] Fix | Delete

* @since 2.0

[24] Fix | Delete

* @package WPMUDEV\Notices

[25] Fix | Delete

[26] Fix | Delete

final class Handler {

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Current version.

[30] Fix | Delete

[31] Fix | Delete

* @since 2.0

[32] Fix | Delete

* @var string $version

[33] Fix | Delete

[34] Fix | Delete

public $version = '2.0.5';

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* Option name to store data.

[38] Fix | Delete

[39] Fix | Delete

* @since 2.0

[40] Fix | Delete

* @var string $option_name

[41] Fix | Delete

[42] Fix | Delete

protected $option_name = 'wpmudev_notices';

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Registered plugins for the opt-ins.

[46] Fix | Delete

[47] Fix | Delete

* @since 2.0

[48] Fix | Delete

* @var array[] $plugins

[49] Fix | Delete

[50] Fix | Delete

private $plugins = array();

[51] Fix | Delete

[52] Fix | Delete

/**

[53] Fix | Delete

* WordPress screen IDs to show notices on.

[54] Fix | Delete

[55] Fix | Delete

* @since 2.0

[56] Fix | Delete

* @var array[] $screens

[57] Fix | Delete

[58] Fix | Delete

private $screens = array();

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Disabled notice types.

[62] Fix | Delete

[63] Fix | Delete

* @since 2.0

[64] Fix | Delete

* @var string[] $disabled

[65] Fix | Delete

[66] Fix | Delete

private $disabled = array( 'email', 'giveaway' );

[67] Fix | Delete

[68] Fix | Delete

/**

[69] Fix | Delete

* Registered plugin notices data from db.

[70] Fix | Delete

[71] Fix | Delete

* @since 2.0

[72] Fix | Delete

* @var array|null $queue

[73] Fix | Delete

[74] Fix | Delete

private $stored = null;

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Notice types that are shown on WP Dashboard.

[78] Fix | Delete

[79] Fix | Delete

* @since 2.0

[80] Fix | Delete

* @var array $wp_notices

[81] Fix | Delete

[82] Fix | Delete

private $wp_notices = array(

[83] Fix | Delete

'email' => '\WPMUDEV\Notices\Notices\Email',

[84] Fix | Delete

'rate' => '\WPMUDEV\Notices\Notices\Rating',

[85] Fix | Delete

);

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Notice type that are shown within plugin pages.

[89] Fix | Delete

[90] Fix | Delete

* @since 2.0

[91] Fix | Delete

* @var array $plugin_notices

[92] Fix | Delete

[93] Fix | Delete

private $plugin_notices = array(

[94] Fix | Delete

'giveaway' => '\WPMUDEV\Notices\Notices\Giveaway',

[95] Fix | Delete

);

[96] Fix | Delete

[97] Fix | Delete

/**

[98] Fix | Delete

* Construct handler class.

[99] Fix | Delete

[100] Fix | Delete

* @since 2.0

[101] Fix | Delete

[102] Fix | Delete

protected function __construct() {

[103] Fix | Delete

// Register plugins.

[104] Fix | Delete

add_action( 'wpmudev_register_notices', array( $this, 'register' ), 10, 2 );

[105] Fix | Delete

[106] Fix | Delete

// Always setup ajax actions.

[107] Fix | Delete

add_action( 'wp_ajax_wpmudev_notices_action', array( $this, 'process_action' ) );

[108] Fix | Delete

[109] Fix | Delete

// Render admin notices.

[110] Fix | Delete

add_action( 'load-index.php', array( $this, 'admin_notice' ) );

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

/**

[114] Fix | Delete

* Initializes and returns the singleton instance.

[115] Fix | Delete

[116] Fix | Delete

* @since 2.0

[117] Fix | Delete

[118] Fix | Delete

* @return static

[119] Fix | Delete

[120] Fix | Delete

public static function instance() {

[121] Fix | Delete

static $instance = null;

[122] Fix | Delete

[123] Fix | Delete

if ( null === $instance ) {

[124] Fix | Delete

$instance = new self();

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

return $instance;

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

/**

[131] Fix | Delete

* Register an active plugin for notices.

[132] Fix | Delete

[133] Fix | Delete

* ```php

[134] Fix | Delete

* do_action(

[135] Fix | Delete

* 'wpmudev_register_notices',

[136] Fix | Delete

* 'beehive', // Plugin id.

[137] Fix | Delete

* array(

[138] Fix | Delete

* 'basename' => plugin_basename( BEEHIVE_PLUGIN_FILE ), // Required: Plugin basename (for backward compat).

[139] Fix | Delete

* 'title' => 'Beehive', // Required: Plugin title.

[140] Fix | Delete

* 'wp_slug' => 'beehive-analytics', // Required: wp.org slug of the plugin.

[141] Fix | Delete

* 'cta_email' => __( 'Get Fast!', 'ga_trans' ), // Email button CTA.

[142] Fix | Delete

* 'installed_on' => time(), // Optional: Plugin activated time.

[143] Fix | Delete

* 'screens' => array( // Required: Plugin screen ids.

[144] Fix | Delete

* 'toplevel_page_beehive',

[145] Fix | Delete

* 'dashboard_page_beehive-accounts',

[146] Fix | Delete

* 'dashboard_page_beehive-settings',

[147] Fix | Delete

* 'dashboard_page_beehive-tutorials',

[148] Fix | Delete

* 'dashboard_page_beehive-google-analytics',

[149] Fix | Delete

* 'dashboard_page_beehive-google-tag-manager',

[150] Fix | Delete

* ),

[151] Fix | Delete

* )

[152] Fix | Delete

* );

[153] Fix | Delete

* ```

[154] Fix | Delete

[155] Fix | Delete

* @since 2.0

[156] Fix | Delete

[157] Fix | Delete

* @param array $options Options.

[158] Fix | Delete

[159] Fix | Delete

* @param string $plugin_id Plugin ID.

[160] Fix | Delete

[161] Fix | Delete

public function register( $plugin_id, array $options = array() ) {

[162] Fix | Delete

// Plugin ID can't be empty.

[163] Fix | Delete

if ( empty( $plugin_id ) ) {

[164] Fix | Delete

return;

[165] Fix | Delete

}

[166] Fix | Delete

[167] Fix | Delete

// Add to the plugins list.

[168] Fix | Delete

$this->plugins[ $plugin_id ] = $options;

[169] Fix | Delete

[170] Fix | Delete

// Setup screens.

[171] Fix | Delete

if ( ! empty( $options['screens'] ) ) {

[172] Fix | Delete

$this->add_to_screens( $plugin_id, $options['screens'] );

[173] Fix | Delete

}

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

/**

[177] Fix | Delete

* Show an admin notice on WP page (not plugin's SUI pages).

[178] Fix | Delete

[179] Fix | Delete

* @since 2.0

[180] Fix | Delete

[181] Fix | Delete

* @return void

[182] Fix | Delete

[183] Fix | Delete

public function admin_notice() {

[184] Fix | Delete

if ( is_super_admin() ) {

[185] Fix | Delete

add_action( 'all_admin_notices', array( $this, 'render_admin_notice' ) );

[186] Fix | Delete

}

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

/**

[190] Fix | Delete

* Show a notice on current plugin page.

[191] Fix | Delete

[192] Fix | Delete

* @since 2.0

[193] Fix | Delete

[194] Fix | Delete

* @return void

[195] Fix | Delete

[196] Fix | Delete

public function plugin_notice() {

[197] Fix | Delete

if ( is_super_admin() ) {

[198] Fix | Delete

add_action( 'all_admin_notices', array( $this, 'render_plugin_notice' ) );

[199] Fix | Delete

}

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

/**

[203] Fix | Delete

* Render admin notice content.

[204] Fix | Delete

[205] Fix | Delete

* @since 2.0

[206] Fix | Delete

[207] Fix | Delete

* @return void

[208] Fix | Delete

[209] Fix | Delete

public function render_admin_notice() {

[210] Fix | Delete

$this->render( false, array_keys( $this->wp_notices ) );

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

/**

[214] Fix | Delete

* Render a plugin notice content.

[215] Fix | Delete

[216] Fix | Delete

* @since 2.0

[217] Fix | Delete

[218] Fix | Delete

* @return void

[219] Fix | Delete

[220] Fix | Delete

public function render_plugin_notice() {

[221] Fix | Delete

// Get current screen.

[222] Fix | Delete

$screen = get_current_screen();

[223] Fix | Delete

[224] Fix | Delete

// Continue only if registered screen.

[225] Fix | Delete

if ( empty( $screen->id ) || empty( $this->screens[ $screen->id ] ) ) {

[226] Fix | Delete

return;

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

$this->render(

[230] Fix | Delete

$this->screens[ $screen->id ],

[231] Fix | Delete

array_keys( $this->plugin_notices )

[232] Fix | Delete

);

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

/**

[236] Fix | Delete

* Process a notice action.

[237] Fix | Delete

[238] Fix | Delete

* All ajax requests from the notice are processed here.

[239] Fix | Delete

* After nonce verification the action will be processed if a matching

[240] Fix | Delete

* method is already defined.

[241] Fix | Delete

[242] Fix | Delete

* @since 2.0

[243] Fix | Delete

[244] Fix | Delete

public function process_action() {

[245] Fix | Delete

// Check required fields.

[246] Fix | Delete

if ( ! isset( $_POST['plugin_id'], $_POST['notice_action'], $_POST['notice_type'], $_POST['nonce'] ) ) {

[247] Fix | Delete

wp_die( esc_html__( 'Required fields are missing.', 'wdev_frash' ) );

[248] Fix | Delete

}

[249] Fix | Delete

[250] Fix | Delete

// Only admins can do this.

[251] Fix | Delete

if ( ! is_super_admin() ) {

[252] Fix | Delete

wp_die( esc_html__( 'Access check failed.', 'wdev_frash' ) );

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

// Get request data.

[256] Fix | Delete

$plugin = sanitize_text_field( wp_unslash( $_POST['plugin_id'] ) );

[257] Fix | Delete

$action = sanitize_text_field( wp_unslash( $_POST['notice_action'] ) );

[258] Fix | Delete

$type = sanitize_text_field( wp_unslash( $_POST['notice_type'] ) );

[259] Fix | Delete

$nonce = sanitize_text_field( wp_unslash( $_POST['nonce'] ) );

[260] Fix | Delete

[261] Fix | Delete

// Verify nonce.

[262] Fix | Delete

if ( ! wp_verify_nonce( $nonce, 'wpmudev_notices_action' ) ) {

[263] Fix | Delete

wp_die( esc_html__( 'Nonce verification failed.', 'wdev_frash' ) );

[264] Fix | Delete

}

[265] Fix | Delete

[266] Fix | Delete

// Initialize the options.

[267] Fix | Delete

$this->init_option();

[268] Fix | Delete

[269] Fix | Delete

// Get the notice class.

[270] Fix | Delete

$notice = $this->get_notice( $plugin, $type );

[271] Fix | Delete

[272] Fix | Delete

// Process action if defined on this class.

[273] Fix | Delete

if ( method_exists( $this, $action ) ) {

[274] Fix | Delete

call_user_func( array( $this, $action ), $plugin, $type );

[275] Fix | Delete

} elseif ( is_object( $notice ) && method_exists( $notice, $action ) ) {

[276] Fix | Delete

// Process action if defined on the notice class.

[277] Fix | Delete

call_user_func( array( $notice, $action ), $plugin );

[278] Fix | Delete

}

[279] Fix | Delete

[280] Fix | Delete

/**

[281] Fix | Delete

* Action hook to do something after a notice action is performed.

[282] Fix | Delete

[283] Fix | Delete

* @since 2.0

[284] Fix | Delete

[285] Fix | Delete

* @param string $plugin Plugin ID.

[286] Fix | Delete

* @param string $type Notice type.

[287] Fix | Delete

[288] Fix | Delete

* @param string $action Action.

[289] Fix | Delete

[290] Fix | Delete

do_action( 'wpmudev_notices_after_notice_action', $action, $plugin, $type );

[291] Fix | Delete

[292] Fix | Delete

wp_die();

[293] Fix | Delete

}

[294] Fix | Delete

[295] Fix | Delete

/**

[296] Fix | Delete

* Remove a notice from the queue.

[297] Fix | Delete

[298] Fix | Delete

* @since 2.0

[299] Fix | Delete

[300] Fix | Delete

* @param string $type Notice type.

[301] Fix | Delete

[302] Fix | Delete

* @param string $plugin Plugin ID.

[303] Fix | Delete

[304] Fix | Delete

* @return void

[305] Fix | Delete

[306] Fix | Delete

public function dismiss_notice( $plugin, $type ) {

[307] Fix | Delete

// Remove from the queue.

[308] Fix | Delete

if ( isset( $this->stored['queue'][ $plugin ][ $type ] ) ) {

[309] Fix | Delete

unset( $this->stored['queue'][ $plugin ][ $type ] );

[310] Fix | Delete

}

[311] Fix | Delete

[312] Fix | Delete

// Setup done list.

[313] Fix | Delete

if ( ! isset( $this->stored['done'][ $plugin ] ) ) {

[314] Fix | Delete

$this->stored['done'][ $plugin ] = array();

[315] Fix | Delete

}

[316] Fix | Delete

[317] Fix | Delete

// Mark as done.

[318] Fix | Delete

$this->stored['done'][ $plugin ][ $type ] = time();

[319] Fix | Delete

[320] Fix | Delete

// Update the queue.

[321] Fix | Delete

$this->update_option();

[322] Fix | Delete

}

[323] Fix | Delete

[324] Fix | Delete

/**

[325] Fix | Delete

* Getter for the queue data.

[326] Fix | Delete

[327] Fix | Delete

* @since 2.0

[328] Fix | Delete

[329] Fix | Delete

* @return array

[330] Fix | Delete

[331] Fix | Delete

public function get_option() {

[332] Fix | Delete

$this->init_option();

[333] Fix | Delete

[334] Fix | Delete

return $this->stored;

[335] Fix | Delete

}

[336] Fix | Delete

[337] Fix | Delete

/**

[338] Fix | Delete

* Update the notices stored data in db.

[339] Fix | Delete

[340] Fix | Delete

* @since 2.0

[341] Fix | Delete

[342] Fix | Delete

* @param array $data Option data (optional).

[343] Fix | Delete

[344] Fix | Delete

* @return bool

[345] Fix | Delete

[346] Fix | Delete

public function update_option( $data = false ) {

[347] Fix | Delete

// If new data is provided use it.

[348] Fix | Delete

if ( ! empty( $data ) ) {

[349] Fix | Delete

$this->stored = $data;

[350] Fix | Delete

}

[351] Fix | Delete

[352] Fix | Delete

// Update the data.

[353] Fix | Delete

return update_site_option( $this->option_name, $this->stored );

[354] Fix | Delete

}

[355] Fix | Delete

[356] Fix | Delete

/**

[357] Fix | Delete

* Render notice for the current screen.

[358] Fix | Delete

[359] Fix | Delete

* @since 2.0

[360] Fix | Delete

[361] Fix | Delete

* @param array $types Notice types to render.

[362] Fix | Delete

[363] Fix | Delete

* @param string|false $plugin_id Plugin id (false to check all plugins).

[364] Fix | Delete

[365] Fix | Delete

* @return void|string

[366] Fix | Delete

[367] Fix | Delete

protected function render( $plugin_id = false, $types = array() ) {

[368] Fix | Delete

// Setup queue when required.

[369] Fix | Delete

$this->setup_queue();

[370] Fix | Delete

[371] Fix | Delete

if ( empty( $plugin_id ) ) {

[372] Fix | Delete

// Get a random notice.

[373] Fix | Delete

$notice = $this->get_random_notice( $types, $plugin_id );

[374] Fix | Delete

} else {

[375] Fix | Delete

// Get a plugin's notice.

[376] Fix | Delete

$notice = $this->get_plugin_notice( $plugin_id, $types );

[377] Fix | Delete

}

[378] Fix | Delete

[379] Fix | Delete

// Render if notice found.

[380] Fix | Delete

if ( ! empty( $notice ) && method_exists( $notice, 'render' ) ) {

[381] Fix | Delete

return call_user_func( array( $notice, 'render' ), $plugin_id );

[382] Fix | Delete

}

[383] Fix | Delete

}

[384] Fix | Delete

[385] Fix | Delete

/**

[386] Fix | Delete

* Set screen IDs for the notices.

[387] Fix | Delete

[388] Fix | Delete

* NOTE: Only one plugin can use one screen id.

[389] Fix | Delete

[390] Fix | Delete

* @since 2.0

[391] Fix | Delete

[392] Fix | Delete

* @param array $screens Screen IDs.

[393] Fix | Delete

[394] Fix | Delete

* @param string $plugin_id Plugin ID.

[395] Fix | Delete

[396] Fix | Delete

* @return void

[397] Fix | Delete

[398] Fix | Delete

protected function add_to_screens( $plugin_id, array $screens ) {

[399] Fix | Delete

// Set the screens.

[400] Fix | Delete

if ( ! empty( $screens ) ) {

[401] Fix | Delete

foreach ( $screens as $screen_id ) {

[402] Fix | Delete

$this->screens[ $screen_id ] = $plugin_id;

[403] Fix | Delete

[404] Fix | Delete

// Remove network suffix for page hook.

[405] Fix | Delete

if ( is_multisite() ) {

[406] Fix | Delete

$screen_id = str_replace( '-network', '', $screen_id );

[407] Fix | Delete

}

[408] Fix | Delete

[409] Fix | Delete

// Register screen notice.

[410] Fix | Delete

add_action( "load-$screen_id", array( $this, 'plugin_notice' ) );

[411] Fix | Delete

}

[412] Fix | Delete

}

[413] Fix | Delete

}

[414] Fix | Delete

[415] Fix | Delete

/**

[416] Fix | Delete

* Setup the notices queue when ready.

[417] Fix | Delete

[418] Fix | Delete

* To avoid calling db queries we need to do this only before

[419] Fix | Delete

* a notice is being rendered.

[420] Fix | Delete

[421] Fix | Delete

* @since 2.0

[422] Fix | Delete

[423] Fix | Delete

* @return void

[424] Fix | Delete

[425] Fix | Delete

protected function setup_queue() {

[426] Fix | Delete

// Initialize data.

[427] Fix | Delete

$this->init_option();

[428] Fix | Delete

[429] Fix | Delete

// Setup all registered plugins to in queue.

[430] Fix | Delete

foreach ( $this->plugins as $plugin_id => $options ) {

[431] Fix | Delete

$this->add_to_queue( $plugin_id, $options );

[432] Fix | Delete

}

[433] Fix | Delete

}

[434] Fix | Delete

[435] Fix | Delete

/**

[436] Fix | Delete

* Set the queue for the plugin if required.

[437] Fix | Delete

[438] Fix | Delete

* We should always schedule all notice types even if they

[439] Fix | Delete

* are disabled. Then only we can enable it later easily.

[440] Fix | Delete

* Disabled notices won't be considered when taken from the queue.

[441] Fix | Delete

[442] Fix | Delete

* @since 2.0

[443] Fix | Delete

[444] Fix | Delete

* @param array $options Options.

[445] Fix | Delete

[446] Fix | Delete

* @param string $plugin_id Plugin ID.

[447] Fix | Delete

[448] Fix | Delete

* @return void

[449] Fix | Delete

[450] Fix | Delete

protected function add_to_queue( $plugin_id, array $options ) {

[451] Fix | Delete

// Store to notice queue if not saved already.

[452] Fix | Delete

if ( ! isset( $this->stored['plugins'][ $plugin_id ] ) ) {

[453] Fix | Delete

// Register plugin.

[454] Fix | Delete

$this->stored['plugins'][ $plugin_id ] = time();

[455] Fix | Delete

$this->stored['queue'][ $plugin_id ] = array();

[456] Fix | Delete

[457] Fix | Delete

// Add notices to queue.

[458] Fix | Delete

foreach ( $this->get_types() as $type => $class_name ) {

[459] Fix | Delete

// Notice class.

[460] Fix | Delete

$notice = $this->get_notice( $plugin_id, $type );

[461] Fix | Delete

// Schedule notice.

[462] Fix | Delete

if ( ! empty( $notice ) ) {

[463] Fix | Delete

$this->stored['queue'][ $plugin_id ][ $type ] = $notice->get_next_schedule( $options['installed_on'] );

[464] Fix | Delete

}

[465] Fix | Delete

}

[466] Fix | Delete

[467] Fix | Delete

// Upgrade if required.

[468] Fix | Delete

if ( ! empty( $options['basename'] ) ) {

[469] Fix | Delete

$this->maybe_upgrade( $plugin_id, $options['basename'] );

[470] Fix | Delete

}

[471] Fix | Delete

[472] Fix | Delete

// Update the stored data.

[473] Fix | Delete

$this->update_option();

[474] Fix | Delete

}

[475] Fix | Delete

}

[476] Fix | Delete

[477] Fix | Delete

/**

[478] Fix | Delete

* Init the notices stored data.

[479] Fix | Delete

[480] Fix | Delete

* Get from the db only if not already initialized.

[481] Fix | Delete

[482] Fix | Delete

* @since 2.0

[483] Fix | Delete

[484] Fix | Delete

protected function init_option() {

[485] Fix | Delete

if ( null === $this->stored ) {

[486] Fix | Delete

$queue = (array) get_site_option( $this->option_name, array() );

[487] Fix | Delete

[488] Fix | Delete

$this->stored = wp_parse_args(

[489] Fix | Delete

$queue,

[490] Fix | Delete

array(

[491] Fix | Delete

'plugins' => array(),

[492] Fix | Delete

'queue' => array(),

[493] Fix | Delete

'done' => array(),

[494] Fix | Delete

)

[495] Fix | Delete

);

[496] Fix | Delete

}

[497] Fix | Delete

}

[498] Fix | Delete

[499] Fix | Delete