Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

[3] Fix | Delete

* @package WPSEO\Admin\Notifications

[4] Fix | Delete

* @since 1.5.3

[5] Fix | Delete

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Implements individual notification.

[9] Fix | Delete

[10] Fix | Delete

class Yoast_Notification {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Type of capability check.

[14] Fix | Delete

[15] Fix | Delete

* @var string

[16] Fix | Delete

[17] Fix | Delete

public const MATCH_ALL = 'all';

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Type of capability check.

[21] Fix | Delete

[22] Fix | Delete

* @var string

[23] Fix | Delete

[24] Fix | Delete

public const MATCH_ANY = 'any';

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Notification type.

[28] Fix | Delete

[29] Fix | Delete

* @var string

[30] Fix | Delete

[31] Fix | Delete

public const ERROR = 'error';

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* Notification type.

[35] Fix | Delete

[36] Fix | Delete

* @var string

[37] Fix | Delete

[38] Fix | Delete

public const WARNING = 'warning';

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* Notification type.

[42] Fix | Delete

[43] Fix | Delete

* @var string

[44] Fix | Delete

[45] Fix | Delete

public const UPDATED = 'updated';

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Options of this Notification.

[49] Fix | Delete

[50] Fix | Delete

* Contains optional arguments:

[51] Fix | Delete

[52] Fix | Delete

* - type: The notification type, i.e. 'updated' or 'error'

[53] Fix | Delete

* - id: The ID of the notification

[54] Fix | Delete

* - nonce: Security nonce to use in case of dismissible notice.

[55] Fix | Delete

* - priority: From 0 to 1, determines the order of Notifications.

[56] Fix | Delete

* - dismissal_key: Option name to save dismissal information in, ID will be used if not supplied.

[57] Fix | Delete

* - capabilities: Capabilities that a user must have for this Notification to show.

[58] Fix | Delete

* - capability_check: How to check capability pass: all or any.

[59] Fix | Delete

* - wpseo_page_only: Only display on wpseo page or on every page.

[60] Fix | Delete

[61] Fix | Delete

* @var array

[62] Fix | Delete

[63] Fix | Delete

private $options = [];

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* Contains default values for the optional arguments.

[67] Fix | Delete

[68] Fix | Delete

* @var array

[69] Fix | Delete

[70] Fix | Delete

private $defaults = [

[71] Fix | Delete

'type' => self::UPDATED,

[72] Fix | Delete

'id' => '',

[73] Fix | Delete

'user_id' => null,

[74] Fix | Delete

'nonce' => null,

[75] Fix | Delete

'priority' => 0.5,

[76] Fix | Delete

'data_json' => [],

[77] Fix | Delete

'dismissal_key' => null,

[78] Fix | Delete

'capabilities' => [],

[79] Fix | Delete

'capability_check' => self::MATCH_ALL,

[80] Fix | Delete

'yoast_branding' => false,

[81] Fix | Delete

];

[82] Fix | Delete

[83] Fix | Delete

/**

[84] Fix | Delete

* The message for the notification.

[85] Fix | Delete

[86] Fix | Delete

* @var string

[87] Fix | Delete

[88] Fix | Delete

private $message;

[89] Fix | Delete

[90] Fix | Delete

/**

[91] Fix | Delete

* Notification class constructor.

[92] Fix | Delete

[93] Fix | Delete

* @param string $message Message string.

[94] Fix | Delete

* @param array $options Set of options.

[95] Fix | Delete

[96] Fix | Delete

public function __construct( $message, $options = [] ) {

[97] Fix | Delete

$this->message = $message;

[98] Fix | Delete

$this->options = $this->normalize_options( $options );

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

/**

[102] Fix | Delete

* Retrieve notification ID string.

[103] Fix | Delete

[104] Fix | Delete

* @return string

[105] Fix | Delete

[106] Fix | Delete

public function get_id() {

[107] Fix | Delete

return $this->options['id'];

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

/**

[111] Fix | Delete

* Retrieve the user to show the notification for.

[112] Fix | Delete

[113] Fix | Delete

* @deprecated 21.6

[114] Fix | Delete

* @codeCoverageIgnore

[115] Fix | Delete

[116] Fix | Delete

* @return WP_User The user to show this notification for.

[117] Fix | Delete

[118] Fix | Delete

public function get_user() {

[119] Fix | Delete

_deprecated_function( __METHOD__, 'Yoast SEO 21.6' );

[120] Fix | Delete

return null;

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Retrieve the id of the user to show the notification for.

[125] Fix | Delete

[126] Fix | Delete

* Returns the id of the current user if not user has been sent.

[127] Fix | Delete

[128] Fix | Delete

* @return int The user id

[129] Fix | Delete

[130] Fix | Delete

public function get_user_id() {

[131] Fix | Delete

return ( $this->options['user_id'] ?? get_current_user_id() );

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

/**

[135] Fix | Delete

* Retrieve nonce identifier.

[136] Fix | Delete

[137] Fix | Delete

* @return string|null Nonce for this Notification.

[138] Fix | Delete

[139] Fix | Delete

public function get_nonce() {

[140] Fix | Delete

if ( $this->options['id'] && empty( $this->options['nonce'] ) ) {

[141] Fix | Delete

$this->options['nonce'] = wp_create_nonce( $this->options['id'] );

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

return $this->options['nonce'];

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

/**

[148] Fix | Delete

* Make sure the nonce is up to date.

[149] Fix | Delete

[150] Fix | Delete

* @return void

[151] Fix | Delete

[152] Fix | Delete

public function refresh_nonce() {

[153] Fix | Delete

if ( $this->options['id'] ) {

[154] Fix | Delete

$this->options['nonce'] = wp_create_nonce( $this->options['id'] );

[155] Fix | Delete

}

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

/**

[159] Fix | Delete

* Get the type of the notification.

[160] Fix | Delete

[161] Fix | Delete

* @return string

[162] Fix | Delete

[163] Fix | Delete

public function get_type() {

[164] Fix | Delete

return $this->options['type'];

[165] Fix | Delete

}

[166] Fix | Delete

[167] Fix | Delete

/**

[168] Fix | Delete

* Priority of the notification.

[169] Fix | Delete

[170] Fix | Delete

* Relative to the type.

[171] Fix | Delete

[172] Fix | Delete

* @return float Returns the priority between 0 and 1.

[173] Fix | Delete

[174] Fix | Delete

public function get_priority() {

[175] Fix | Delete

return $this->options['priority'];

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

/**

[179] Fix | Delete

* Get the User Meta key to check for dismissal of notification.

[180] Fix | Delete

[181] Fix | Delete

* @return string User Meta Option key that registers dismissal.

[182] Fix | Delete

[183] Fix | Delete

public function get_dismissal_key() {

[184] Fix | Delete

if ( empty( $this->options['dismissal_key'] ) ) {

[185] Fix | Delete

return $this->options['id'];

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

return $this->options['dismissal_key'];

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

/**

[192] Fix | Delete

* Is this Notification persistent.

[193] Fix | Delete

[194] Fix | Delete

* @return bool True if persistent, False if fire and forget.

[195] Fix | Delete

[196] Fix | Delete

public function is_persistent() {

[197] Fix | Delete

$id = $this->get_id();

[198] Fix | Delete

[199] Fix | Delete

return ! empty( $id );

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

/**

[203] Fix | Delete

* Check if the notification is relevant for the current user.

[204] Fix | Delete

[205] Fix | Delete

* @return bool True if a user needs to see this notification, false if not.

[206] Fix | Delete

[207] Fix | Delete

public function display_for_current_user() {

[208] Fix | Delete

// If the notification is for the current page only, always show.

[209] Fix | Delete

if ( ! $this->is_persistent() ) {

[210] Fix | Delete

return true;

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

// If the current user doesn't match capabilities.

[214] Fix | Delete

return $this->match_capabilities();

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

/**

[218] Fix | Delete

* Does the current user match required capabilities.

[219] Fix | Delete

[220] Fix | Delete

* @return bool

[221] Fix | Delete

[222] Fix | Delete

public function match_capabilities() {

[223] Fix | Delete

// Super Admin can do anything.

[224] Fix | Delete

if ( is_multisite() && is_super_admin( $this->options['user_id'] ) ) {

[225] Fix | Delete

return true;

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

/**

[229] Fix | Delete

* Filter capabilities that enable the displaying of this notification.

[230] Fix | Delete

[231] Fix | Delete

* @param array $capabilities The capabilities that must be present for this notification.

[232] Fix | Delete

* @param Yoast_Notification $notification The notification object.

[233] Fix | Delete

[234] Fix | Delete

* @return array Array of capabilities or empty for no restrictions.

[235] Fix | Delete

[236] Fix | Delete

* @since 3.2

[237] Fix | Delete

[238] Fix | Delete

$capabilities = apply_filters( 'wpseo_notification_capabilities', $this->options['capabilities'], $this );

[239] Fix | Delete

[240] Fix | Delete

// Should be an array.

[241] Fix | Delete

if ( ! is_array( $capabilities ) ) {

[242] Fix | Delete

$capabilities = (array) $capabilities;

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

/**

[246] Fix | Delete

* Filter capability check to enable all or any capabilities.

[247] Fix | Delete

[248] Fix | Delete

* @param string $capability_check The type of check that will be used to determine if an capability is present.

[249] Fix | Delete

* @param Yoast_Notification $notification The notification object.

[250] Fix | Delete

[251] Fix | Delete

* @return string self::MATCH_ALL or self::MATCH_ANY.

[252] Fix | Delete

[253] Fix | Delete

* @since 3.2

[254] Fix | Delete

[255] Fix | Delete

$capability_check = apply_filters( 'wpseo_notification_capability_check', $this->options['capability_check'], $this );

[256] Fix | Delete

[257] Fix | Delete

if ( ! in_array( $capability_check, [ self::MATCH_ALL, self::MATCH_ANY ], true ) ) {

[258] Fix | Delete

$capability_check = self::MATCH_ALL;

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

if ( ! empty( $capabilities ) ) {

[262] Fix | Delete

[263] Fix | Delete

$has_capabilities = array_filter( $capabilities, [ $this, 'has_capability' ] );

[264] Fix | Delete

[265] Fix | Delete

switch ( $capability_check ) {

[266] Fix | Delete

case self::MATCH_ALL:

[267] Fix | Delete

return $has_capabilities === $capabilities;

[268] Fix | Delete

case self::MATCH_ANY:

[269] Fix | Delete

return ! empty( $has_capabilities );

[270] Fix | Delete

}

[271] Fix | Delete

}

[272] Fix | Delete

[273] Fix | Delete

return true;

[274] Fix | Delete

}

[275] Fix | Delete

[276] Fix | Delete

/**

[277] Fix | Delete

* Array filter function to find matched capabilities.

[278] Fix | Delete

[279] Fix | Delete

* @param string $capability Capability to test.

[280] Fix | Delete

[281] Fix | Delete

* @return bool

[282] Fix | Delete

[283] Fix | Delete

private function has_capability( $capability ) {

[284] Fix | Delete

$user_id = $this->options['user_id'];

[285] Fix | Delete

if ( ! is_numeric( $user_id ) ) {

[286] Fix | Delete

return false;

[287] Fix | Delete

}

[288] Fix | Delete

$user = get_user_by( 'id', $user_id );

[289] Fix | Delete

if ( ! $user ) {

[290] Fix | Delete

return false;

[291] Fix | Delete

}

[292] Fix | Delete

[293] Fix | Delete

return $user->has_cap( $capability );

[294] Fix | Delete

}

[295] Fix | Delete

[296] Fix | Delete

/**

[297] Fix | Delete

* Return the object properties as an array.

[298] Fix | Delete

[299] Fix | Delete

* @return array

[300] Fix | Delete

[301] Fix | Delete

public function to_array() {

[302] Fix | Delete

return [

[303] Fix | Delete

'message' => $this->message,

[304] Fix | Delete

'options' => $this->options,

[305] Fix | Delete

];

[306] Fix | Delete

}

[307] Fix | Delete

[308] Fix | Delete

/**

[309] Fix | Delete

* Adds string (view) behaviour to the notification.

[310] Fix | Delete

[311] Fix | Delete

* @return string

[312] Fix | Delete

[313] Fix | Delete

public function __toString() {

[314] Fix | Delete

return $this->render();

[315] Fix | Delete

}

[316] Fix | Delete

[317] Fix | Delete

/**

[318] Fix | Delete

* Renders the notification as a string.

[319] Fix | Delete

[320] Fix | Delete

* @return string The rendered notification.

[321] Fix | Delete

[322] Fix | Delete

public function render() {

[323] Fix | Delete

$attributes = [];

[324] Fix | Delete

[325] Fix | Delete

// Default notification classes.

[326] Fix | Delete

$classes = [

[327] Fix | Delete

'yoast-notification',

[328] Fix | Delete

];

[329] Fix | Delete

[330] Fix | Delete

// Maintain WordPress visualisation of notifications when they are not persistent.

[331] Fix | Delete

if ( ! $this->is_persistent() ) {

[332] Fix | Delete

$classes[] = 'notice';

[333] Fix | Delete

$classes[] = $this->get_type();

[334] Fix | Delete

}

[335] Fix | Delete

[336] Fix | Delete

if ( ! empty( $classes ) ) {

[337] Fix | Delete

$attributes['class'] = implode( ' ', $classes );

[338] Fix | Delete

}

[339] Fix | Delete

[340] Fix | Delete

// Combined attribute key and value into a string.

[341] Fix | Delete

array_walk( $attributes, [ $this, 'parse_attributes' ] );

[342] Fix | Delete

[343] Fix | Delete

$message = null;

[344] Fix | Delete

if ( $this->options['yoast_branding'] ) {

[345] Fix | Delete

$message = $this->wrap_yoast_seo_icon( $this->message );

[346] Fix | Delete

}

[347] Fix | Delete

[348] Fix | Delete

if ( $message === null ) {

[349] Fix | Delete

$message = wpautop( $this->message );

[350] Fix | Delete

}

[351] Fix | Delete

[352] Fix | Delete

// Build the output DIV.

[353] Fix | Delete

return '<div ' . implode( ' ', $attributes ) . '>' . $message . '</div>' . PHP_EOL;

[354] Fix | Delete

}

[355] Fix | Delete

[356] Fix | Delete

/**

[357] Fix | Delete

* Wraps the message with a Yoast SEO icon.

[358] Fix | Delete

[359] Fix | Delete

* @param string $message The message to wrap.

[360] Fix | Delete

[361] Fix | Delete

* @return string The wrapped message.

[362] Fix | Delete

[363] Fix | Delete

private function wrap_yoast_seo_icon( $message ) {

[364] Fix | Delete

$out = sprintf(

[365] Fix | Delete

'<img src="%1$s" height="%2$d" width="%3$d" class="yoast-seo-icon" />',

[366] Fix | Delete

esc_url( plugin_dir_url( WPSEO_FILE ) . 'packages/js/images/Yoast_SEO_Icon.svg' ),

[367] Fix | Delete

60,

[368] Fix | Delete

[369] Fix | Delete

);

[370] Fix | Delete

$out .= '<div class="yoast-seo-icon-wrap">';

[371] Fix | Delete

$out .= $message;

[372] Fix | Delete

$out .= '</div>';

[373] Fix | Delete

[374] Fix | Delete

return $out;

[375] Fix | Delete

}

[376] Fix | Delete

[377] Fix | Delete

/**

[378] Fix | Delete

* Get the JSON if provided.

[379] Fix | Delete

[380] Fix | Delete

* @return false|string

[381] Fix | Delete

[382] Fix | Delete

public function get_json() {

[383] Fix | Delete

if ( empty( $this->options['data_json'] ) ) {

[384] Fix | Delete

return '';

[385] Fix | Delete

}

[386] Fix | Delete

[387] Fix | Delete

return WPSEO_Utils::format_json_encode( $this->options['data_json'] );

[388] Fix | Delete

}

[389] Fix | Delete

[390] Fix | Delete

/**

[391] Fix | Delete

* Make sure we only have values that we can work with.

[392] Fix | Delete

[393] Fix | Delete

* @param array $options Options to normalize.

[394] Fix | Delete

[395] Fix | Delete

* @return array

[396] Fix | Delete

[397] Fix | Delete

private function normalize_options( $options ) {

[398] Fix | Delete

$options = wp_parse_args( $options, $this->defaults );

[399] Fix | Delete

[400] Fix | Delete

// Should not exceed 0 or 1.

[401] Fix | Delete

$options['priority'] = min( 1, max( 0, $options['priority'] ) );

[402] Fix | Delete

[403] Fix | Delete

// Set default capabilities when not supplied.

[404] Fix | Delete

if ( empty( $options['capabilities'] ) || $options['capabilities'] === [] ) {

[405] Fix | Delete

$options['capabilities'] = [ 'wpseo_manage_options' ];

[406] Fix | Delete

}

[407] Fix | Delete

[408] Fix | Delete

// Set to the id of the current user if not supplied.

[409] Fix | Delete

if ( $options['user_id'] === null ) {

[410] Fix | Delete

$options['user_id'] = get_current_user_id();

[411] Fix | Delete

}

[412] Fix | Delete

[413] Fix | Delete

return $options;

[414] Fix | Delete

}

[415] Fix | Delete

[416] Fix | Delete

/**

[417] Fix | Delete

* Format HTML element attributes.

[418] Fix | Delete

[419] Fix | Delete

* @param string $value Attribute value.

[420] Fix | Delete

* @param string $key Attribute name.

[421] Fix | Delete

[422] Fix | Delete

* @return void

[423] Fix | Delete

[424] Fix | Delete

private function parse_attributes( &$value, $key ) {

[425] Fix | Delete

$value = sprintf( '%s="%s"', sanitize_key( $key ), esc_attr( $value ) );

[426] Fix | Delete

}

[427] Fix | Delete

}

[428] Fix | Delete

[429] Fix | Delete