Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

[3] Fix | Delete

* @package WPSEO\Admin

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Implements server-side user input validation.

[8] Fix | Delete

[9] Fix | Delete

* @since 12.0

[10] Fix | Delete

[11] Fix | Delete

class Yoast_Input_Validation {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* The error descriptions.

[15] Fix | Delete

[16] Fix | Delete

* @since 12.1

[17] Fix | Delete

[18] Fix | Delete

* @var array

[19] Fix | Delete

[20] Fix | Delete

private static $error_descriptions = [];

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Check whether an option group is a Yoast SEO setting.

[24] Fix | Delete

[25] Fix | Delete

* The normal pattern is 'yoast' . $option_name . 'options'.

[26] Fix | Delete

[27] Fix | Delete

* @since 12.0

[28] Fix | Delete

[29] Fix | Delete

* @param string $group_name The option group name.

[30] Fix | Delete

[31] Fix | Delete

* @return bool Whether or not it's an Yoast SEO option group.

[32] Fix | Delete

[33] Fix | Delete

public static function is_yoast_option_group_name( $group_name ) {

[34] Fix | Delete

return ( strpos( $group_name, 'yoast' ) !== false );

[35] Fix | Delete

}

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Adds an error message to the document title when submitting a settings

[39] Fix | Delete

* form and errors are returned.

[40] Fix | Delete

[41] Fix | Delete

* Uses the WordPress `admin_title` filter in the WPSEO_Option subclasses.

[42] Fix | Delete

[43] Fix | Delete

* @since 12.0

[44] Fix | Delete

[45] Fix | Delete

* @param string $admin_title The page title, with extra context added.

[46] Fix | Delete

[47] Fix | Delete

* @return string The modified or original admin title.

[48] Fix | Delete

[49] Fix | Delete

public static function add_yoast_admin_document_title_errors( $admin_title ) {

[50] Fix | Delete

$errors = get_settings_errors();

[51] Fix | Delete

$error_count = 0;

[52] Fix | Delete

[53] Fix | Delete

foreach ( $errors as $error ) {

[54] Fix | Delete

// For now, filter the admin title only in the Yoast SEO settings pages.

[55] Fix | Delete

if ( self::is_yoast_option_group_name( $error['setting'] ) && $error['code'] !== 'settings_updated' ) {

[56] Fix | Delete

++$error_count;

[57] Fix | Delete

}

[58] Fix | Delete

}

[59] Fix | Delete

[60] Fix | Delete

if ( $error_count > 0 ) {

[61] Fix | Delete

return sprintf(

[62] Fix | Delete

/* translators: %1$s: amount of errors, %2$s: the admin page title */

[63] Fix | Delete

_n( 'The form contains %1$s error. %2$s', 'The form contains %1$s errors. %2$s', $error_count, 'wordpress-seo' ),

[64] Fix | Delete

number_format_i18n( $error_count ),

[65] Fix | Delete

$admin_title

[66] Fix | Delete

);

[67] Fix | Delete

}

[68] Fix | Delete

[69] Fix | Delete

return $admin_title;

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

/**

[73] Fix | Delete

* Checks whether a specific form input field was submitted with an invalid value.

[74] Fix | Delete

[75] Fix | Delete

* @since 12.1

[76] Fix | Delete

[77] Fix | Delete

* @param string $error_code Must be the same slug-name used for the field variable and for `add_settings_error()`.

[78] Fix | Delete

[79] Fix | Delete

* @return bool Whether or not the submitted input field contained an invalid value.

[80] Fix | Delete

[81] Fix | Delete

public static function yoast_form_control_has_error( $error_code ) {

[82] Fix | Delete

$errors = get_settings_errors();

[83] Fix | Delete

[84] Fix | Delete

foreach ( $errors as $error ) {

[85] Fix | Delete

if ( $error['code'] === $error_code ) {

[86] Fix | Delete

return true;

[87] Fix | Delete

}

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

return false;

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Sets the error descriptions.

[95] Fix | Delete

[96] Fix | Delete

* @since 12.1

[97] Fix | Delete

[98] Fix | Delete

* @param array $descriptions An associative array of error descriptions.

[99] Fix | Delete

* For each entry, the key must be the setting variable.

[100] Fix | Delete

[101] Fix | Delete

* @return void

[102] Fix | Delete

[103] Fix | Delete

public static function set_error_descriptions( $descriptions = [] ) {

[104] Fix | Delete

$defaults = [

[105] Fix | Delete

'baiduverify' => sprintf(

[106] Fix | Delete

/* translators: %s: additional message with the submitted invalid value */

[107] Fix | Delete

esc_html__( 'Baidu verification codes can only contain letters, numbers, hyphens, and underscores. %s', 'wordpress-seo' ),

[108] Fix | Delete

self::get_dirty_value_message( 'baiduverify' )

[109] Fix | Delete

[110] Fix | Delete

'facebook_site' => sprintf(

[111] Fix | Delete

/* translators: %s: additional message with the submitted invalid value */

[112] Fix | Delete

esc_html__( 'Please check the format of the Facebook Page URL you entered. %s', 'wordpress-seo' ),

[113] Fix | Delete

self::get_dirty_value_message( 'facebook_site' )

[114] Fix | Delete

[115] Fix | Delete

'googleverify' => sprintf(

[116] Fix | Delete

/* translators: %s: additional message with the submitted invalid value */

[117] Fix | Delete

esc_html__( 'Google verification codes can only contain letters, numbers, hyphens, and underscores. %s', 'wordpress-seo' ),

[118] Fix | Delete

self::get_dirty_value_message( 'googleverify' )

[119] Fix | Delete

[120] Fix | Delete

'instagram_url' => sprintf(

[121] Fix | Delete

/* translators: %s: additional message with the submitted invalid value */

[122] Fix | Delete

esc_html__( 'Please check the format of the Instagram URL you entered. %s', 'wordpress-seo' ),

[123] Fix | Delete

self::get_dirty_value_message( 'instagram_url' )

[124] Fix | Delete

[125] Fix | Delete

'linkedin_url' => sprintf(

[126] Fix | Delete

/* translators: %s: additional message with the submitted invalid value */

[127] Fix | Delete

esc_html__( 'Please check the format of the LinkedIn URL you entered. %s', 'wordpress-seo' ),

[128] Fix | Delete

self::get_dirty_value_message( 'linkedin_url' )

[129] Fix | Delete

[130] Fix | Delete

'msverify' => sprintf(

[131] Fix | Delete

/* translators: %s: additional message with the submitted invalid value */

[132] Fix | Delete

esc_html__( 'Bing confirmation codes can only contain letters from A to F, numbers, hyphens, and underscores. %s', 'wordpress-seo' ),

[133] Fix | Delete

self::get_dirty_value_message( 'msverify' )

[134] Fix | Delete

[135] Fix | Delete

'myspace_url' => sprintf(

[136] Fix | Delete

/* translators: %s: additional message with the submitted invalid value */

[137] Fix | Delete

esc_html__( 'Please check the format of the MySpace URL you entered. %s', 'wordpress-seo' ),

[138] Fix | Delete

self::get_dirty_value_message( 'myspace_url' )

[139] Fix | Delete

[140] Fix | Delete

'pinterest_url' => sprintf(

[141] Fix | Delete

/* translators: %s: additional message with the submitted invalid value */

[142] Fix | Delete

esc_html__( 'Please check the format of the Pinterest URL you entered. %s', 'wordpress-seo' ),

[143] Fix | Delete

self::get_dirty_value_message( 'pinterest_url' )

[144] Fix | Delete

[145] Fix | Delete

'pinterestverify' => sprintf(

[146] Fix | Delete

/* translators: %s: additional message with the submitted invalid value */

[147] Fix | Delete

esc_html__( 'Pinterest confirmation codes can only contain letters from A to F, numbers, hyphens, and underscores. %s', 'wordpress-seo' ),

[148] Fix | Delete

self::get_dirty_value_message( 'pinterestverify' )

[149] Fix | Delete

[150] Fix | Delete

'twitter_site' => sprintf(

[151] Fix | Delete

/* translators: %s: additional message with the submitted invalid value */

[152] Fix | Delete

esc_html__( 'Twitter usernames can only contain letters, numbers, and underscores. %s', 'wordpress-seo' ),

[153] Fix | Delete

self::get_dirty_value_message( 'twitter_site' )

[154] Fix | Delete

[155] Fix | Delete

'wikipedia_url' => sprintf(

[156] Fix | Delete

/* translators: %s: additional message with the submitted invalid value */

[157] Fix | Delete

esc_html__( 'Please check the format of the Wikipedia URL you entered. %s', 'wordpress-seo' ),

[158] Fix | Delete

self::get_dirty_value_message( 'wikipedia_url' )

[159] Fix | Delete

[160] Fix | Delete

'yandexverify' => sprintf(

[161] Fix | Delete

/* translators: %s: additional message with the submitted invalid value */

[162] Fix | Delete

esc_html__( 'Yandex confirmation codes can only contain letters from A to F, numbers, hyphens, and underscores. %s', 'wordpress-seo' ),

[163] Fix | Delete

self::get_dirty_value_message( 'yandexverify' )

[164] Fix | Delete

[165] Fix | Delete

'youtube_url' => sprintf(

[166] Fix | Delete

/* translators: %s: additional message with the submitted invalid value */

[167] Fix | Delete

esc_html__( 'Please check the format of the YouTube URL you entered. %s', 'wordpress-seo' ),

[168] Fix | Delete

self::get_dirty_value_message( 'youtube_url' )

[169] Fix | Delete

[170] Fix | Delete

];

[171] Fix | Delete

[172] Fix | Delete

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

[173] Fix | Delete

[174] Fix | Delete

self::$error_descriptions = $descriptions;

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

/**

[178] Fix | Delete

* Gets all the error descriptions.

[179] Fix | Delete

[180] Fix | Delete

* @since 12.1

[181] Fix | Delete

[182] Fix | Delete

* @return array An associative array of error descriptions.

[183] Fix | Delete

[184] Fix | Delete

public static function get_error_descriptions() {

[185] Fix | Delete

return self::$error_descriptions;

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

/**

[189] Fix | Delete

* Gets a specific error description.

[190] Fix | Delete

[191] Fix | Delete

* @since 12.1

[192] Fix | Delete

[193] Fix | Delete

* @param string $error_code Code of the error set via `add_settings_error()`, normally the variable name.

[194] Fix | Delete

[195] Fix | Delete

* @return string|null The error description.

[196] Fix | Delete

[197] Fix | Delete

public static function get_error_description( $error_code ) {

[198] Fix | Delete

if ( ! isset( self::$error_descriptions[ $error_code ] ) ) {

[199] Fix | Delete

return null;

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

return self::$error_descriptions[ $error_code ];

[203] Fix | Delete

}

[204] Fix | Delete

[205] Fix | Delete

/**

[206] Fix | Delete

* Gets the aria-invalid HTML attribute based on the submitted invalid value.

[207] Fix | Delete

[208] Fix | Delete

* @since 12.1

[209] Fix | Delete

[210] Fix | Delete

* @param string $error_code Code of the error set via `add_settings_error()`, normally the variable name.

[211] Fix | Delete

[212] Fix | Delete

* @return string The aria-invalid HTML attribute or empty string.

[213] Fix | Delete

[214] Fix | Delete

public static function get_the_aria_invalid_attribute( $error_code ) {

[215] Fix | Delete

if ( self::yoast_form_control_has_error( $error_code ) ) {

[216] Fix | Delete

return ' aria-invalid="true"';

[217] Fix | Delete

}

[218] Fix | Delete

[219] Fix | Delete

return '';

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

/**

[223] Fix | Delete

* Gets the aria-describedby HTML attribute based on the submitted invalid value.

[224] Fix | Delete

[225] Fix | Delete

* @since 12.1

[226] Fix | Delete

[227] Fix | Delete

* @param string $error_code Code of the error set via `add_settings_error()`, normally the variable name.

[228] Fix | Delete

[229] Fix | Delete

* @return string The aria-describedby HTML attribute or empty string.

[230] Fix | Delete

[231] Fix | Delete

public static function get_the_aria_describedby_attribute( $error_code ) {

[232] Fix | Delete

if ( self::yoast_form_control_has_error( $error_code ) && self::get_error_description( $error_code ) ) {

[233] Fix | Delete

return ' aria-describedby="' . esc_attr( $error_code ) . '-error-description"';

[234] Fix | Delete

}

[235] Fix | Delete

[236] Fix | Delete

return '';

[237] Fix | Delete

}

[238] Fix | Delete

[239] Fix | Delete

/**

[240] Fix | Delete

* Gets the error description wrapped in a HTML paragraph.

[241] Fix | Delete

[242] Fix | Delete

* @since 12.1

[243] Fix | Delete

[244] Fix | Delete

* @param string $error_code Code of the error set via `add_settings_error()`, normally the variable name.

[245] Fix | Delete

[246] Fix | Delete

* @return string The error description HTML or empty string.

[247] Fix | Delete

[248] Fix | Delete

public static function get_the_error_description( $error_code ) {

[249] Fix | Delete

$error_description = self::get_error_description( $error_code );

[250] Fix | Delete

[251] Fix | Delete

if ( self::yoast_form_control_has_error( $error_code ) && $error_description ) {

[252] Fix | Delete

return '<p id="' . esc_attr( $error_code ) . '-error-description" class="yoast-input-validation__error-description">' . $error_description . '</p>';

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

return '';

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

/**

[259] Fix | Delete

* Adds the submitted invalid value to the WordPress `$wp_settings_errors` global.

[260] Fix | Delete

[261] Fix | Delete

* @since 12.1

[262] Fix | Delete

[263] Fix | Delete

* @param string $error_code Code of the error set via `add_settings_error()`, normally the variable name.

[264] Fix | Delete

* @param string $dirty_value The submitted invalid value.

[265] Fix | Delete

[266] Fix | Delete

* @return void

[267] Fix | Delete

[268] Fix | Delete

public static function add_dirty_value_to_settings_errors( $error_code, $dirty_value ) {

[269] Fix | Delete

global $wp_settings_errors;

[270] Fix | Delete

[271] Fix | Delete

if ( ! is_array( $wp_settings_errors ) ) {

[272] Fix | Delete

return;

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

foreach ( $wp_settings_errors as $index => $error ) {

[276] Fix | Delete

if ( $error['code'] === $error_code ) {

[277] Fix | Delete

// phpcs:ignore WordPress.WP.GlobalVariablesOverride -- This is a deliberate action.

[278] Fix | Delete

$wp_settings_errors[ $index ]['yoast_dirty_value'] = $dirty_value;

[279] Fix | Delete

}

[280] Fix | Delete

}

[281] Fix | Delete

}

[282] Fix | Delete

[283] Fix | Delete

/**

[284] Fix | Delete

* Gets an invalid submitted value.

[285] Fix | Delete

[286] Fix | Delete

* @since 12.1

[287] Fix | Delete

[288] Fix | Delete

* @param string $error_code Code of the error set via `add_settings_error()`, normally the variable name.

[289] Fix | Delete

[290] Fix | Delete

* @return string The submitted invalid input field value.

[291] Fix | Delete

[292] Fix | Delete

public static function get_dirty_value( $error_code ) {

[293] Fix | Delete

$errors = get_settings_errors();

[294] Fix | Delete

[295] Fix | Delete

foreach ( $errors as $error ) {

[296] Fix | Delete

if ( $error['code'] === $error_code && isset( $error['yoast_dirty_value'] ) ) {

[297] Fix | Delete

return $error['yoast_dirty_value'];

[298] Fix | Delete

}

[299] Fix | Delete

}

[300] Fix | Delete

[301] Fix | Delete

return '';

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete

/**

[305] Fix | Delete

* Gets a specific invalid value message.

[306] Fix | Delete

[307] Fix | Delete

* @since 12.1

[308] Fix | Delete

[309] Fix | Delete

* @param string $error_code Code of the error set via `add_settings_error()`, normally the variable name.

[310] Fix | Delete

[311] Fix | Delete

* @return string The error invalid value message or empty string.

[312] Fix | Delete

[313] Fix | Delete

public static function get_dirty_value_message( $error_code ) {

[314] Fix | Delete

$dirty_value = self::get_dirty_value( $error_code );

[315] Fix | Delete

[316] Fix | Delete

if ( $dirty_value ) {

[317] Fix | Delete

return sprintf(

[318] Fix | Delete

/* translators: %s: form value as submitted. */

[319] Fix | Delete

esc_html__( 'The submitted value was: %s', 'wordpress-seo' ),

[320] Fix | Delete

esc_html( $dirty_value )

[321] Fix | Delete

);

[322] Fix | Delete

}

[323] Fix | Delete

[324] Fix | Delete

return '';

[325] Fix | Delete

}

[326] Fix | Delete

}

[327] Fix | Delete

[328] Fix | Delete