Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

[3] Fix | Delete

* @package WPSEO\Admin\Notifiers

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Abstract class representing a dismissible notification.

[8] Fix | Delete

[9] Fix | Delete

abstract class WPSEO_Dismissible_Notification implements WPSEO_Listener, WPSEO_Notification_Handler {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* The identifier for the notification.

[13] Fix | Delete

[14] Fix | Delete

* @var string

[15] Fix | Delete

[16] Fix | Delete

protected $notification_identifier = '';

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Retrieves instance of a notification.

[20] Fix | Delete

[21] Fix | Delete

* @return Yoast_Notification The notification.

[22] Fix | Delete

[23] Fix | Delete

abstract protected function get_notification();

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Listens to an argument in the request URL and triggers an action.

[27] Fix | Delete

[28] Fix | Delete

* @return void

[29] Fix | Delete

[30] Fix | Delete

public function listen() {

[31] Fix | Delete

if ( $this->get_listener_value() !== $this->notification_identifier ) {

[32] Fix | Delete

return;

[33] Fix | Delete

}

[34] Fix | Delete

[35] Fix | Delete

$this->dismiss();

[36] Fix | Delete

}

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Adds the notification if applicable, otherwise removes it.

[40] Fix | Delete

[41] Fix | Delete

* @param Yoast_Notification_Center $notification_center The notification center object.

[42] Fix | Delete

[43] Fix | Delete

* @return void

[44] Fix | Delete

[45] Fix | Delete

public function handle( Yoast_Notification_Center $notification_center ) {

[46] Fix | Delete

if ( $this->is_applicable() ) {

[47] Fix | Delete

$notification = $this->get_notification();

[48] Fix | Delete

$notification_center->add_notification( $notification );

[49] Fix | Delete

[50] Fix | Delete

return;

[51] Fix | Delete

}

[52] Fix | Delete

[53] Fix | Delete

$notification_center->remove_notification_by_id( 'wpseo-' . $this->notification_identifier );

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Listens to an argument in the request URL and triggers an action.

[58] Fix | Delete

[59] Fix | Delete

* @return void

[60] Fix | Delete

[61] Fix | Delete

protected function dismiss() {

[62] Fix | Delete

$this->set_dismissal_state();

[63] Fix | Delete

$this->redirect_to_dashboard();

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Checks if a notice is applicable.

[68] Fix | Delete

[69] Fix | Delete

* @return bool Whether a notice should be shown or not.

[70] Fix | Delete

[71] Fix | Delete

protected function is_applicable() {

[72] Fix | Delete

return $this->is_notice_dismissed() === false;

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Checks whether the notification has been dismissed.

[77] Fix | Delete

[78] Fix | Delete

* @codeCoverageIgnore

[79] Fix | Delete

[80] Fix | Delete

* @return bool True when notification is dismissed.

[81] Fix | Delete

[82] Fix | Delete

protected function is_notice_dismissed() {

[83] Fix | Delete

return get_user_meta( get_current_user_id(), 'wpseo-remove-' . $this->notification_identifier, true ) === '1';

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

/**

[87] Fix | Delete

* Retrieves the value where listener is listening for.

[88] Fix | Delete

[89] Fix | Delete

* @codeCoverageIgnore

[90] Fix | Delete

[91] Fix | Delete

* @return string|null The listener value or null if not set.

[92] Fix | Delete

[93] Fix | Delete

protected function get_listener_value() {

[94] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: Normally we would need to check for a nonce here but this class is not used anymore.

[95] Fix | Delete

if ( isset( $_GET['yoast_dismiss'] ) && is_string( $_GET['yoast_dismiss'] ) ) {

[96] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: Normally we would need to check for a nonce here but this class is not used anymore.

[97] Fix | Delete

return sanitize_text_field( wp_unslash( $_GET['yoast_dismiss'] ) );

[98] Fix | Delete

}

[99] Fix | Delete

return null;

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

/**

[103] Fix | Delete

* Dismisses the notification.

[104] Fix | Delete

[105] Fix | Delete

* @codeCoverageIgnore

[106] Fix | Delete

[107] Fix | Delete

* @return void

[108] Fix | Delete

[109] Fix | Delete

protected function set_dismissal_state() {

[110] Fix | Delete

update_user_meta( get_current_user_id(), 'wpseo-remove-' . $this->notification_identifier, true );

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

/**

[114] Fix | Delete

* Redirects the user back to the dashboard.

[115] Fix | Delete

[116] Fix | Delete

* @codeCoverageIgnore

[117] Fix | Delete

[118] Fix | Delete

* @return void

[119] Fix | Delete

[120] Fix | Delete

protected function redirect_to_dashboard() {

[121] Fix | Delete

wp_safe_redirect( admin_url( 'admin.php?page=wpseo_dashboard' ) );

[122] Fix | Delete

exit;

[123] Fix | Delete

}

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete