ldc-sbv/pole-sbv-content/plugins/wordpress-seo/inc/class-wpseo-utils.php
2017-11-10 11:45:43 +01:00

1081 lines
27 KiB
PHP
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?php
/**
* @package WPSEO\Internals
* @since 1.8.0
*/
/**
* Group of utility methods for use by WPSEO
* All methods are static, this is just a sort of namespacing class wrapper.
*/
class WPSEO_Utils {
/**
* @var bool $has_filters Whether the PHP filter extension is enabled
* @static
* @since 1.8.0
*/
public static $has_filters;
/**
* @var array notifications to be shown in the JavaScript console
* @static
* @since 3.3.2
*/
protected static $console_notifications = array();
/**
* Check whether the current user is allowed to access the configuration.
*
* @static
*
* @since 1.8.0
*
* @return boolean
*/
public static function grant_access() {
// @todo add deprecation warning
if ( ! is_multisite() ) {
return true;
}
$options = get_site_option( 'wpseo_ms' );
if ( empty( $options['access'] ) || $options['access'] === 'admin' ) {
return current_user_can( 'wpseo_manage_options' );
}
return is_super_admin();
}
/**
* Check whether file editing is allowed for the .htaccess and robots.txt files
*
* {@internal current_user_can() checks internally whether a user is on wp-ms and adjusts accordingly.}}
*
* @static
*
* @since 1.8.0
*
* @return bool
*/
public static function allow_system_file_edit() {
$allowed = true;
if ( current_user_can( 'edit_files' ) === false ) {
$allowed = false;
}
/**
* Filter: 'wpseo_allow_system_file_edit' - Allow developers to change whether the editing of
* .htaccess and robots.txt is allowed
*
* @api bool $allowed Whether file editing is allowed
*/
return apply_filters( 'wpseo_allow_system_file_edit', $allowed );
}
/**
* Check if the web server is running on Apache
*
* @static
*
* @since 1.8.0
*
* @return bool
*/
public static function is_apache() {
if ( isset( $_SERVER['SERVER_SOFTWARE'] ) && stristr( $_SERVER['SERVER_SOFTWARE'], 'apache' ) !== false ) {
return true;
}
return false;
}
/**
* Check if the web server is running on Nginx
*
* @static
*
* @since 1.8.0
*
* @return bool
*/
public static function is_nginx() {
if ( isset( $_SERVER['SERVER_SOFTWARE'] ) && stristr( $_SERVER['SERVER_SOFTWARE'], 'nginx' ) !== false ) {
return true;
}
return false;
}
/**
* Register a notification to be shown in the JavaScript console
*
* @since 3.3.2
*
* @param string $identifier Notification identifier.
* @param string $message Message to be shown.
* @param bool $one_time_only Only show once (if added multiple times).
*/
public static function javascript_console_notification( $identifier, $message, $one_time_only = false ) {
static $registered_hook;
if ( is_null( $registered_hook ) ) {
add_action( 'admin_footer', array( __CLASS__, 'localize_console_notices' ), 999 );
$registered_hook = true;
}
$prefix = 'Yoast SEO: ';
if ( substr( $message, 0, strlen( $prefix ) ) !== $prefix ) {
$message = $prefix . $message;
}
if ( $one_time_only ) {
self::$console_notifications[ $identifier ] = $message;
}
else {
self::$console_notifications[] = $message;
}
}
/**
* Localize the console notifications to JavaScript
*
* @since 3.3.2
*/
public static function localize_console_notices() {
if ( empty( self::$console_notifications ) ) {
return;
}
wp_localize_script( WPSEO_Admin_Asset_Manager::PREFIX . 'admin-global-script', 'wpseoConsoleNotifications', array_values( self::$console_notifications ) );
}
/**
* Check whether a url is relative
*
* @since 1.8.0
*
* @param string $url URL string to check.
*
* @return bool
*/
public static function is_url_relative( $url ) {
return ( strpos( $url, 'http' ) !== 0 && strpos( $url, '//' ) !== 0 );
}
/**
* List all the available user roles
*
* @since 1.8.0
*
* @static
*
* @return array $roles
*/
public static function get_roles() {
global $wp_roles;
if ( ! isset( $wp_roles ) ) {
$wp_roles = new WP_Roles();
}
$roles = $wp_roles->get_names();
return $roles;
}
/**
* Standardize whitespace in a string
*
* Replace line breaks, carriage returns, tabs with a space, then remove double spaces.
*
* @since 1.8.0
*
* @param string $string String input to standardize.
*
* @return string
*/
public static function standardize_whitespace( $string ) {
return trim( str_replace( ' ', ' ', str_replace( array( "\t", "\n", "\r", "\f" ), ' ', $string ) ) );
}
/**
* First strip out registered and enclosing shortcodes using native WordPress strip_shortcodes function.
* Then strip out the shortcodes with a filthy regex, because people don't properly register their shortcodes.
*
* @static
*
* @since 1.8.0
*
* @param string $text Input string that might contain shortcodes.
*
* @return string $text string without shortcodes
*/
public static function strip_shortcode( $text ) {
return preg_replace( '`\[[^\]]+\]`s', '', strip_shortcodes( $text ) );
}
/**
* Recursively trim whitespace round a string value or of string values within an array
* Only trims strings to avoid typecasting a variable (to string)
*
* @static
*
* @since 1.8.0
*
* @param mixed $value Value to trim or array of values to trim.
*
* @return mixed Trimmed value or array of trimmed values
*/
public static function trim_recursive( $value ) {
if ( is_string( $value ) ) {
$value = trim( $value );
}
elseif ( is_array( $value ) ) {
$value = array_map( array( __CLASS__, 'trim_recursive' ), $value );
}
return $value;
}
/**
* Translates a decimal analysis score into a textual one.
*
* @static
*
* @since 1.8.0
*
* @param int $val The decimal score to translate.
* @param bool $css_value Whether to return the i18n translated score or the CSS class value.
*
* @return string
*/
public static function translate_score( $val, $css_value = true ) {
$seo_rank = WPSEO_Rank::from_numeric_score( $val );
if ( $css_value ) {
return $seo_rank->get_css_class();
}
return $seo_rank->get_label();
}
/**
* Emulate the WP native sanitize_text_field function in a %%variable%% safe way
*
* @see https://core.trac.wordpress.org/browser/trunk/src/wp-includes/formatting.php for the original
*
* Sanitize a string from user input or from the db
*
* check for invalid UTF-8,
* Convert single < characters to entity,
* strip all tags,
* remove line breaks, tabs and extra white space,
* strip octets - BUT DO NOT REMOVE (part of) VARIABLES WHICH WILL BE REPLACED.
*
* @static
*
* @since 1.8.0
*
* @param string $value String value to sanitize.
*
* @return string
*/
public static function sanitize_text_field( $value ) {
$filtered = wp_check_invalid_utf8( $value );
if ( strpos( $filtered, '<' ) !== false ) {
$filtered = wp_pre_kses_less_than( $filtered );
// This will strip extra whitespace for us.
$filtered = wp_strip_all_tags( $filtered, true );
}
else {
$filtered = trim( preg_replace( '`[\r\n\t ]+`', ' ', $filtered ) );
}
$found = false;
while ( preg_match( '`[^%](%[a-f0-9]{2})`i', $filtered, $match ) ) {
$filtered = str_replace( $match[1], '', $filtered );
$found = true;
}
unset( $match );
if ( $found ) {
// Strip out the whitespace that may now exist after removing the octets.
$filtered = trim( preg_replace( '` +`', ' ', $filtered ) );
}
/**
* Filter a sanitized text field string.
*
* @since WP 2.9.0
*
* @param string $filtered The sanitized string.
* @param string $str The string prior to being sanitized.
*/
return apply_filters( 'sanitize_text_field', $filtered, $value );
}
/**
* Sanitize a url for saving to the database
* Not to be confused with the old native WP function
*
* @todo [JRF => whomever] check/improve url verification
*
* @since 1.8.0
*
* @param string $value String URL value to sanitize.
* @param array $allowed_protocols Optional set of allowed protocols.
*
* @return string
*/
public static function sanitize_url( $value, $allowed_protocols = array( 'http', 'https' ) ) {
return esc_url_raw( sanitize_text_field( rawurldecode( $value ) ), $allowed_protocols );
}
/**
* Validate a value as boolean
*
* @static
*
* @since 1.8.0
*
* @param mixed $value Value to validate.
*
* @return bool
*/
public static function validate_bool( $value ) {
if ( ! isset( self::$has_filters ) ) {
self::$has_filters = extension_loaded( 'filter' );
}
if ( self::$has_filters ) {
return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
}
else {
return self::emulate_filter_bool( $value );
}
}
/**
* Cast a value to bool
*
* @static
*
* @since 1.8.0
*
* @param mixed $value Value to cast.
*
* @return bool
*/
public static function emulate_filter_bool( $value ) {
$true = array(
'1',
'true',
'True',
'TRUE',
'y',
'Y',
'yes',
'Yes',
'YES',
'on',
'On',
'ON',
);
$false = array(
'0',
'false',
'False',
'FALSE',
'n',
'N',
'no',
'No',
'NO',
'off',
'Off',
'OFF',
);
if ( is_bool( $value ) ) {
return $value;
}
elseif ( is_int( $value ) && ( $value === 0 || $value === 1 ) ) {
return (bool) $value;
}
elseif ( ( is_float( $value ) && ! is_nan( $value ) ) && ( $value === (float) 0 || $value === (float) 1 ) ) {
return (bool) $value;
}
elseif ( is_string( $value ) ) {
$value = trim( $value );
if ( in_array( $value, $true, true ) ) {
return true;
}
elseif ( in_array( $value, $false, true ) ) {
return false;
}
else {
return false;
}
}
return false;
}
/**
* Validate a value as integer
*
* @static
*
* @since 1.8.0
*
* @param mixed $value Value to validate.
*
* @return int|bool int or false in case of failure to convert to int
*/
public static function validate_int( $value ) {
if ( ! isset( self::$has_filters ) ) {
self::$has_filters = extension_loaded( 'filter' );
}
if ( self::$has_filters ) {
return filter_var( $value, FILTER_VALIDATE_INT );
}
else {
return self::emulate_filter_int( $value );
}
}
/**
* Cast a value to integer
*
* @static
*
* @since 1.8.0
*
* @param mixed $value Value to cast.
*
* @return int|bool
*/
public static function emulate_filter_int( $value ) {
if ( is_int( $value ) ) {
return $value;
}
elseif ( is_float( $value ) ) {
if ( (int) $value == $value && ! is_nan( $value ) ) {
return (int) $value;
}
else {
return false;
}
}
elseif ( is_string( $value ) ) {
$value = trim( $value );
if ( $value === '' ) {
return false;
}
elseif ( ctype_digit( $value ) ) {
return (int) $value;
}
elseif ( strpos( $value, '-' ) === 0 && ctype_digit( substr( $value, 1 ) ) ) {
return (int) $value;
}
else {
return false;
}
}
return false;
}
/**
* Clears the WP or W3TC cache depending on which is used
*
* @static
*
* @since 1.8.0
*/
public static function clear_cache() {
if ( function_exists( 'w3tc_pgcache_flush' ) ) {
w3tc_pgcache_flush();
}
elseif ( function_exists( 'wp_cache_clear_cache' ) ) {
wp_cache_clear_cache();
}
}
/**
* Flush W3TC cache after succesfull update/add of taxonomy meta option
*
* @static
*
* @since 1.8.0
*/
public static function flush_w3tc_cache() {
if ( defined( 'W3TC_DIR' ) && function_exists( 'w3tc_objectcache_flush' ) ) {
w3tc_objectcache_flush();
}
}
/**
* Clear rewrite rules
*
* @static
*
* @since 1.8.0
*/
public static function clear_rewrites() {
delete_option( 'rewrite_rules' );
}
/**
* Do simple reliable math calculations without the risk of wrong results
*
* @see http://floating-point-gui.de/
* @see the big red warning on http://php.net/language.types.float.php
*
* In the rare case that the bcmath extension would not be loaded, it will return the normal calculation results
*
* @static
*
* @since 1.5.0
* @since 1.8.0 Moved from stand-alone function to this class.
*
* @param mixed $number1 Scalar (string/int/float/bool).
* @param string $action Calculation action to execute. Valid input:
* '+' or 'add' or 'addition',
* '-' or 'sub' or 'subtract',
* '*' or 'mul' or 'multiply',
* '/' or 'div' or 'divide',
* '%' or 'mod' or 'modulus'
* '=' or 'comp' or 'compare'.
* @param mixed $number2 Scalar (string/int/float/bool).
* @param bool $round Whether or not to round the result. Defaults to false.
* Will be disregarded for a compare operation.
* @param int $decimals Decimals for rounding operation. Defaults to 0.
* @param int $precision Calculation precision. Defaults to 10.
*
* @return mixed Calculation Result or false if either or the numbers isn't scalar or
* an invalid operation was passed
* - for compare the result will always be an integer
* - for all other operations, the result will either be an integer (preferred)
* or a float
*/
public static function calc( $number1, $action, $number2, $round = false, $decimals = 0, $precision = 10 ) {
static $bc;
if ( ! is_scalar( $number1 ) || ! is_scalar( $number2 ) ) {
return false;
}
if ( ! isset( $bc ) ) {
$bc = extension_loaded( 'bcmath' );
}
if ( $bc ) {
$number1 = number_format( $number1, 10, '.', '' );
$number2 = number_format( $number2, 10, '.', '' );
}
$result = null;
$compare = false;
switch ( $action ) {
case '+':
case 'add':
case 'addition':
$result = ( $bc ) ? bcadd( $number1, $number2, $precision ) /* string */ : ( $number1 + $number2 );
break;
case '-':
case 'sub':
case 'subtract':
$result = ( $bc ) ? bcsub( $number1, $number2, $precision ) /* string */ : ( $number1 - $number2 );
break;
case '*':
case 'mul':
case 'multiply':
$result = ( $bc ) ? bcmul( $number1, $number2, $precision ) /* string */ : ( $number1 * $number2 );
break;
case '/':
case 'div':
case 'divide':
if ( $bc ) {
$result = bcdiv( $number1, $number2, $precision ); // String, or NULL if right_operand is 0.
}
elseif ( $number2 != 0 ) {
$result = ( $number1 / $number2 );
}
if ( ! isset( $result ) ) {
$result = 0;
}
break;
case '%':
case 'mod':
case 'modulus':
if ( $bc ) {
$result = bcmod( $number1, $number2 ); // String, or NULL if modulus is 0.
}
elseif ( $number2 != 0 ) {
$result = ( $number1 % $number2 );
}
if ( ! isset( $result ) ) {
$result = 0;
}
break;
case '=':
case 'comp':
case 'compare':
$compare = true;
if ( $bc ) {
$result = bccomp( $number1, $number2, $precision ); // Returns int 0, 1 or -1.
}
else {
$result = ( $number1 == $number2 ) ? 0 : ( ( $number1 > $number2 ) ? 1 : - 1 );
}
break;
}
if ( isset( $result ) ) {
if ( $compare === false ) {
if ( $round === true ) {
$result = round( floatval( $result ), $decimals );
if ( $decimals === 0 ) {
$result = (int) $result;
}
}
else {
$result = ( intval( $result ) == $result ) ? intval( $result ) : floatval( $result );
}
}
return $result;
}
return false;
}
/**
* Trim whitespace and NBSP (Non-breaking space) from string
*
* @since 2.0.0
*
* @param string $string String input to trim.
*
* @return string
*/
public static function trim_nbsp_from_string( $string ) {
$find = array( '&nbsp;', chr( 0xC2 ) . chr( 0xA0 ) );
$string = str_replace( $find, ' ', $string );
$string = trim( $string );
return $string;
}
/**
* Check if a string is a valid datetime
*
* @since 2.0.0
*
* @param string $datetime String input to check as valid input for DateTime class.
*
* @return bool
*/
public static function is_valid_datetime( $datetime ) {
if ( substr( $datetime, 0, 1 ) === '-' ) {
return false;
}
try {
return new DateTime( $datetime ) !== false;
} catch ( Exception $exc ) {
return false;
}
}
/**
* Format the URL to be sure it is okay for using as a redirect url.
*
* This method will parse the URL and combine them in one string.
*
* @since 2.3.0
*
* @param string $url URL string.
*
* @return mixed
*/
public static function format_url( $url ) {
$parsed_url = wp_parse_url( $url );
$formatted_url = '';
if ( ! empty( $parsed_url['path'] ) ) {
$formatted_url = $parsed_url['path'];
}
// Prepend a slash if first char != slash.
if ( stripos( $formatted_url, '/' ) !== 0 ) {
$formatted_url = '/' . $formatted_url;
}
// Append 'query' string if it exists.
if ( isset( $parsed_url['query'] ) && '' != $parsed_url['query'] ) {
$formatted_url .= '?' . $parsed_url['query'];
}
return apply_filters( 'wpseo_format_admin_url', $formatted_url );
}
/**
* Get plugin name from file
*
* @since 2.3.3
*
* @param string $plugin Plugin path relative to plugins directory.
*
* @return string|bool
*/
public static function get_plugin_name( $plugin ) {
$plugin_details = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin );
if ( $plugin_details['Name'] != '' ) {
return $plugin_details['Name'];
}
return false;
}
/**
* Retrieves the sitename.
*
* @since 3.0.0
*
* @return string
*/
public static function get_site_name() {
return trim( strip_tags( get_bloginfo( 'name' ) ) );
}
/**
* Retrieves the title separator.
*
* @since 3.0.0
*
* @return string
*/
public static function get_title_separator() {
$replacement = WPSEO_Options::get_default( 'wpseo_titles', 'separator' );
// Get the titles option and the separator options.
$titles_options = WPSEO_Options::get_option( 'wpseo_titles' );
$seperator_options = WPSEO_Option_Titles::get_instance()->get_separator_options();
// This should always be set, but just to be sure.
if ( isset( $seperator_options[ $titles_options['separator'] ] ) ) {
// Set the new replacement.
$replacement = $seperator_options[ $titles_options['separator'] ];
}
/**
* Filter: 'wpseo_replacements_filter_sep' - Allow customization of the separator character(s)
*
* @api string $replacement The current separator
*/
return apply_filters( 'wpseo_replacements_filter_sep', $replacement );
}
/**
* Check if the current opened page is a Yoast SEO page.
*
* @since 3.0.0
*
* @return bool
*/
public static function is_yoast_seo_page() {
static $is_yoast_seo;
if ( $is_yoast_seo === null ) {
$current_page = filter_input( INPUT_GET, 'page' );
$is_yoast_seo = ( substr( $current_page, 0, 6 ) === 'wpseo_' );
}
return $is_yoast_seo;
}
/**
* Check if the current opened page belongs to Yoast SEO Free.
*
* @since 3.3.0
*
* @param string $current_page the current page the user is on.
*
* @return bool
*/
public static function is_yoast_seo_free_page( $current_page ) {
$yoast_seo_free_pages = array(
'wpseo_dashboard',
'wpseo_titles',
'wpseo_social',
'wpseo_xml',
'wpseo_advanced',
'wpseo_tools',
'wpseo_search_console',
'wpseo_licenses',
);
return in_array( $current_page, $yoast_seo_free_pages );
}
/**
* Checks if we are in the premium or free plugin.
*
* @return bool True when we are in the premium plugin.
*/
public static function is_yoast_seo_premium() {
return defined( 'WPSEO_PREMIUM_PLUGIN_FILE' );
}
/**
* Determine if Yoast SEO is in development mode?
*
* Inspired by JetPack (https://github.com/Automattic/jetpack/blob/master/class.jetpack.php#L1383-L1406).
*
* @since 3.0.0
*
* @return bool
*/
public static function is_development_mode() {
$development_mode = false;
if ( defined( 'WPSEO_DEBUG' ) ) {
$development_mode = WPSEO_DEBUG;
}
elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
$development_mode = true;
}
/**
* Filter the Yoast SEO development mode.
*
* @since 3.0
*
* @param bool $development_mode Is Yoast SEOs development mode active.
*/
return apply_filters( 'yoast_seo_development_mode', $development_mode );
}
/**
* Retrieve home URL with proper trailing slash.
*
* @since 3.3.0
*
* @param string $path Path relative to home URL.
* @param string|null $scheme Scheme to apply.
*
* @return string Home URL with optional path, appropriately slashed if not.
*/
public static function home_url( $path = '', $scheme = null ) {
$home_url = home_url( $path, $scheme );
if ( ! empty( $path ) ) {
return $home_url;
}
// @todo Replace with call to wp_parse_url() once minimum requirement has gone up to WP 4.7.
$home_path = parse_url( $home_url, PHP_URL_PATH );
if ( '/' === $home_path ) { // Home at site root, already slashed.
return $home_url;
}
if ( is_null( $home_path ) ) { // Home at site root, always slash.
return trailingslashit( $home_url );
}
if ( is_string( $home_path ) ) { // Home in subdirectory, slash if permalink structure has slash.
return user_trailingslashit( $home_url );
}
return $home_url;
}
/**
* Returns a base64 URL for the svg for use in the menu
*
* @since 3.3.0
*
* @param bool $base64 Whether or not to return base64'd output.
*
* @return string
*/
public static function get_icon_svg( $base64 = true ) {
$svg = '<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xml:space="preserve" width="100%" height="100%" style="fill:#82878c" viewBox="0 0 512 512"><g><g><g><g><path d="M203.6,395c6.8-17.4,6.8-36.6,0-54l-79.4-204h70.9l47.7,149.4l74.8-207.6H116.4c-41.8,0-76,34.2-76,76V357c0,41.8,34.2,76,76,76H173C189,424.1,197.6,410.3,203.6,395z"/></g><g><path d="M471.6,154.8c0-41.8-34.2-76-76-76h-3L285.7,365c-9.6,26.7-19.4,49.3-30.3,68h216.2V154.8z"/></g></g><path stroke-width="2.974" stroke-miterlimit="10" d="M338,1.3l-93.3,259.1l-42.1-131.9h-89.1l83.8,215.2c6,15.5,6,32.5,0,48c-7.4,19-19,37.3-53,41.9l-7.2,1v76h8.3c81.7,0,118.9-57.2,149.6-142.9L431.6,1.3H338z M279.4,362c-32.9,92-67.6,128.7-125.7,131.8v-45c37.5-7.5,51.3-31,59.1-51.1c7.5-19.3,7.5-40.7,0-60l-75-192.7h52.8l53.3,166.8l105.9-294h58.1L279.4,362z"/></g></g></svg>';
if ( $base64 ) {
return 'data:image/svg+xml;base64,' . base64_encode( $svg );
}
return $svg;
}
/**
* Returns the language part of a given locale, defaults to english when the $locale is empty
*
* @since 3.4
*
* @param string $locale The locale to get the language of.
*
* @returns string The language part of the locale.
*/
public static function get_language( $locale ) {
$language = 'en';
if ( ! empty( $locale ) && strlen( $locale ) >= 2 ) {
$language = substr( $locale, 0, 2 );
}
return $language;
}
/**
* Returns the user locale for the language to be used in the admin.
*
* WordPress 4.7 introduced the ability for users to specify an Admin language
* different from the language used on the front end. This checks if the feature
* is available and returns the user's language, with a fallback to the site's language.
* Can be removed when support for WordPress 4.6 will be dropped, in favor
* of WordPress get_user_locale() that already fallbacks to the site’s locale.
*
* @since 4.1
*
* @returns string The locale.
*/
public static function get_user_locale() {
if ( function_exists( 'get_user_locale' ) ) {
return get_user_locale();
}
return get_locale();
}
/**
* Checks if the WP-REST-API is available.
*
* @since 3.6
* @since 3.7 Introduced the $minimum_version parameter.
*
* @param string $minimum_version The minimum version the API should be.
*
* @return bool Returns true if the API is available.
*/
public static function is_api_available( $minimum_version = '2.0' ) {
return ( defined( 'REST_API_VERSION' )
&& version_compare( REST_API_VERSION, $minimum_version, '>=' ) );
}
/********************** DEPRECATED METHODS **********************/
// @codeCoverageIgnoreStart
/**
* Wrapper for the PHP filter input function.
*
* This is used because stupidly enough, the `filter_input` function is not available on all hosts...
*
* @since 1.8.0
*
* @deprecated 3.0
* @deprecated Passes through to PHP call, no longer used in code.
*
* @param int $type Input type constant.
* @param string $variable_name Variable name to get.
* @param int $filter Filter to apply.
*
* @return mixed
*/
public static function filter_input( $type, $variable_name, $filter = FILTER_DEFAULT ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0', 'PHP native filter_input()' );
return filter_input( $type, $variable_name, $filter );
}
/**
* Adds a hook that when given option is updated, the XML sitemap transient cache is cleared
*
* @since 2.2.0
*
* @deprecated 3.2
* @see WPSEO_Sitemaps_Cache::register_clear_on_option_update()
*
* @param string $option Option name.
* @param string $type Sitemap type.
*/
public static function register_cache_clear_option( $option, $type = '' ) {
_deprecated_function( __METHOD__, 'WPSEO 3.2', 'WPSEO_Sitemaps_Cache::register_clear_on_option_update()' );
WPSEO_Sitemaps_Cache::register_clear_on_option_update( $option, $type );
}
/**
* Clears the transient cache when a given option is updated, if that option has been registered before
*
* @since 2.2.0
*
* @deprecated 3.2
* @see WPSEO_Sitemaps_Cache::clear_on_option_update()
*
* @param string $option The option that's being updated.
*/
public static function clear_transient_cache( $option ) {
_deprecated_function( __METHOD__, 'WPSEO 3.2', 'WPSEO_Sitemaps_Cache::clear_on_option_update()' );
WPSEO_Sitemaps_Cache::clear_on_option_update( $option );
}
/**
* Clear entire XML sitemap cache
*
* @since 1.8.0
*
* @deprecated 3.2
* @see WPSEO_Sitemaps_Cache::clear()
*
* @param array $types Set of sitemap types to invalidate cache for.
*/
public static function clear_sitemap_cache( $types = array() ) {
_deprecated_function( __METHOD__, 'WPSEO 3.2', 'WPSEO_Sitemaps_Cache::clear()' );
WPSEO_Sitemaps_Cache::clear( $types );
}
/**
* Wrapper for encoding the array as a json string. Includes a fallback if wp_json_encode doesn't exist.
*
* @since 3.0.0
*
* @deprecated 3.3 Core versions without wp_json_encode() no longer supported, fallback unnecessary.
*
* @param array $array_to_encode The array which will be encoded.
* @param int $options Optional. Array with options which will be passed in to the encoding methods.
* @param int $depth Optional. Maximum depth to walk through $data. Must be greater than 0. Default 512.
*
* @return false|string
*/
public static function json_encode( array $array_to_encode, $options = 0, $depth = 512 ) {
_deprecated_function( __METHOD__, 'WPSEO 3.3', 'wp_json_encode()' );
return wp_json_encode( $array_to_encode, $options, $depth );
}
// @codeCoverageIgnoreEnd
}