'-' 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( ' ', 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 ( ! empty( $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 wp_strip_all_tags( get_bloginfo( 'name' ), true );
}
/**
* 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.
$separator = WPSEO_Options::get( 'separator' );
$seperator_options = WPSEO_Option_Titles::get_instance()->get_separator_options();
// This should always be set, but just to be sure.
if ( isset( $seperator_options[ $separator ] ) ) {
// Set the new replacement.
$replacement = $seperator_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_advanced',
'wpseo_tools',
'wpseo_search_console',
'wpseo_licenses',
);
return in_array( $current_page, $yoast_seo_free_pages, true );
}
/**
* 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;
}
$home_path = wp_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 = '';
if ( $base64 ) {
return 'data:image/svg+xml;base64,' . base64_encode( $svg );
}
return $svg;
}
/**
* Returns the SVG for the traffic light in the metabox.
*
* @return string
*/
public static function traffic_light_svg() {
return <<
SVG;
}
/**
* 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, '>=' ) );
}
/**
* Determine whether or not the metabox should be displayed for a post type.
*
* @param string|null $post_type Optional. The post type to check the visibility of the metabox for.
*
* @return bool Whether or not the metabox should be displayed.
*/
protected static function display_post_type_metabox( $post_type = null ) {
if ( ! isset( $post_type ) ) {
$post_type = get_post_type();
}
if ( ! isset( $post_type ) || ! WPSEO_Post_Type::is_post_type_accessible( $post_type ) ) {
return false;
}
if ( $post_type === 'attachment' && WPSEO_Options::get( 'disable-attachment' ) ) {
return false;
}
return WPSEO_Options::get( 'display-metabox-pt-' . $post_type );
}
/**
* Determine whether or not the metabox should be displayed for a taxonomy.
*
* @param string|null $taxonomy Optional. The post type to check the visibility of the metabox for.
*
* @return bool Whether or not the metabox should be displayed.
*/
protected static function display_taxonomy_metabox( $taxonomy = null ) {
if ( ! isset( $taxonomy ) || ! in_array( $taxonomy, get_taxonomies( array( 'public' => true ), 'names' ), true ) ) {
return false;
}
return WPSEO_Options::get( 'display-metabox-tax-' . $taxonomy );
}
/**
* Determines whether the metabox is active for the given identifier and type.
*
* @param string $identifier The identifier to check for.
* @param string $type The type to check for.
*
* @return bool Whether or not the metabox is active.
*/
public static function is_metabox_active( $identifier, $type ) {
if ( $type === 'post_type' ) {
return self::display_post_type_metabox( $identifier );
}
if ( $type === 'taxonomy' ) {
return self::display_taxonomy_metabox( $identifier );
}
return false;
}
/**
* Determines whether or not WooCommerce is active.
*
* @return bool Whether or not WooCommerce is active.
*/
public static function is_woocommerce_active() {
return class_exists( 'Woocommerce' );
}
/**
* Determines whether the plugin is active for the entire network.
*
* @return bool Whether or not the plugin is network-active.
*/
public static function is_plugin_network_active() {
static $network_active = null;
if ( ! is_multisite() ) {
return false;
}
// If a cached result is available, bail early.
if ( $network_active !== null ) {
return $network_active;
}
$network_active_plugins = wp_get_active_network_plugins();
// Consider MU plugins and network-activated plugins as network-active.
$network_active = strpos( wp_normalize_path( WPSEO_FILE ), wp_normalize_path( WPMU_PLUGIN_DIR ) ) === 0
|| in_array( WP_PLUGIN_DIR . '/' . WPSEO_BASENAME, $network_active_plugins, true );
return $network_active;
}
/**
* Getter for the Adminl10n array. Applies the wpseo_admin_l10n filter.
*
* @return array The Adminl10n array.
*/
public static function get_admin_l10n() {
$wpseo_admin_l10n = array();
$additional_entries = apply_filters( 'wpseo_admin_l10n', array() );
if ( is_array( $additional_entries ) ) {
$wpseo_admin_l10n = array_merge( $wpseo_admin_l10n, $additional_entries );
}
return $wpseo_admin_l10n;
}
/**
* Retrieves the analysis worker log level. Defaults to errors only.
*
* Uses bool YOAST_SEO_DEBUG as flag to enable logging. Off equals ERROR.
* Uses string YOAST_SEO_DEBUG_ANALYSIS_WORKER as log level for the Analysis
* Worker. Defaults to INFO.
* Can be: TRACE, DEBUG, INFO, WARN or ERROR.
*
* @return string The log level to use.
*/
public static function get_analysis_worker_log_level() {
if ( defined( 'YOAST_SEO_DEBUG' ) && YOAST_SEO_DEBUG ) {
return defined( 'YOAST_SEO_DEBUG_ANALYSIS_WORKER' ) ? YOAST_SEO_DEBUG_ANALYSIS_WORKER : 'INFO';
}
return 'ERROR';
}
/**
* Returns the home url with the following modifications:
*
* In case of a multisite setup we return the network_home_url.
* In case of no multisite setup we return the home_url while overriding the WPML filter.
*
* @codeCoverageIgnore
*
* @return string The home url.
*/
public static function get_home_url() {
// Add a new filter to undo WPML's changing of home url.
add_filter( 'wpml_get_home_url', array( 'WPSEO_Utils', 'wpml_get_home_url' ), 10, 2 );
$url = home_url();
// If the plugin is network activated, use the network home URL.
if ( self::is_plugin_network_active() ) {
$url = network_home_url();
}
remove_filter( 'wpml_get_home_url', array( 'WPSEO_Utils', 'wpml_get_home_url' ), 10 );
return $url;
}
/**
* Returns the original URL instead of the language-enriched URL.
* This method gets automatically triggered by the wpml_get_home_url filter.
*
* @codeCoverageIgnore
*
* @param string $home_url The url altered by WPML. Unused.
* @param string $url The url that isn't altered by WPML.
*
* @return string The original url.
*/
public static function wpml_get_home_url( $home_url, $url ) {
return $url;
}
/**
* Checks if the current installation supports MyYoast access tokens.
*
* @codeCoverageIgnore
*
* @return bool True if access_tokens are supported.
*/
public static function has_access_token_support() {
return class_exists( 'WPSEO_MyYoast_Client' );
}
/**
* Prepares data for outputting as JSON.
*
* @param array $data The data to format.
*
* @return false|string The prepared JSON string.
*/
public static function format_json_encode( $data ) {
$flags = 0;
if ( version_compare( PHP_VERSION, '5.4', '>=' ) ) {
// @codingStandardsIgnoreLine This is used in the wp_json_encode call, which checks for this.
$flags = ( $flags | JSON_UNESCAPED_SLASHES );
}
if ( self::is_development_mode() ) {
$flags = ( $flags | JSON_PRETTY_PRINT );
/**
* Filter the Yoast SEO development mode.
*
* @api array $data Allows filtering of the JSON data for debug purposes.
*/
$data = apply_filters( 'wpseo_debug_json_data', $data );
}
return wp_json_encode( $data, $flags );
}
/**
* Output a Schema blob.
*
* @param array $graph The Schema graph array to output.
* @param string $class The (optional) class to add to the script tag.
*
* @return bool
*/
public static function schema_output( $graph, $class = 'yoast-schema-graph' ) {
if ( ! is_array( $graph ) || empty( $graph ) ) {
return false;
}
// phpcs:ignore WordPress.Security.EscapeOutput -- Escaping happens in WPSEO_Utils::schema_tag, which should be whitelisted.
echo self::schema_tag( $graph, $class );
return true;
}
/**
* Returns a script tag with Schema blob.
*
* @param array $graph The Schema graph array to output.
* @param string $class The (optional) class to add to the script tag.
*
* @return false|string A schema blob with script tags.
*/
public static function schema_tag( $graph, $class = 'yoast-schema-graph' ) {
if ( ! is_array( $graph ) || empty( $graph ) ) {
return false;
}
$output = array(
'@context' => 'https://schema.org',
'@graph' => $graph,
);
return "' . "\n";
}
/**
* Extends the allowed post tags with accessibility-related attributes.
*
* @param array $allowed_post_tags The allowed post tags.
* @codeCoverageIgnore
*
* @return array The allowed tags including post tags, input tags and select tags.
*/
public static function extend_kses_post_with_a11y( $allowed_post_tags ) {
static $a11y_tags;
if ( isset( $a11y_tags ) === false ) {
$a11y_tags = array(
'button' => array(
'aria-expanded' => true,
'aria-controls' => true,
),
'div' => array(
'tabindex' => true,
),
// Below are attributes that are needed for backwards compatibility (WP < 5.1).
'span' => array(
'aria-hidden' => true,
),
'input' => array(
'aria-describedby' => true,
),
'select' => array(
'aria-describedby' => true,
),
'textarea' => array(
'aria-describedby' => true,
),
);
// Add the global allowed attributes to each html element.
$a11y_tags = array_map( '_wp_add_global_attributes', $a11y_tags );
}
return array_merge_recursive( $allowed_post_tags, $a11y_tags );
}
/**
* Extends the allowed post tags with input, select and option tags.
*
* @param array $allowed_post_tags The allowed post tags.
* @codeCoverageIgnore
*
* @return array The allowed tags including post tags, input tags, select tags and option tags.
*/
public static function extend_kses_post_with_forms( $allowed_post_tags ) {
static $input_tags;
if ( isset( $input_tags ) === false ) {
$input_tags = array(
'input' => array(
'accept' => true,
'accesskey' => true,
'align' => true,
'alt' => true,
'autocomplete' => true,
'autofocus' => true,
'checked' => true,
'contenteditable' => true,
'dirname' => true,
'disabled' => true,
'draggable' => true,
'dropzone' => true,
'form' => true,
'formaction' => true,
'formenctype' => true,
'formmethod' => true,
'formnovalidate' => true,
'formtarget' => true,
'height' => true,
'hidden' => true,
'lang' => true,
'list' => true,
'max' => true,
'maxlength' => true,
'min' => true,
'multiple' => true,
'name' => true,
'pattern' => true,
'placeholder' => true,
'readonly' => true,
'required' => true,
'size' => true,
'spellcheck' => true,
'src' => true,
'step' => true,
'tabindex' => true,
'translate' => true,
'type' => true,
'value' => true,
'width' => true,
/*
* Below are attributes that are needed for backwards compatibility (WP < 5.1).
* They are used for the social media image in the metabox.
* These can be removed once we move to the React versions of the social previews.
*/
'data-target' => true,
'data-target-id' => true,
),
'select' => array(
'accesskey' => true,
'autofocus' => true,
'contenteditable' => true,
'disabled' => true,
'draggable' => true,
'dropzone' => true,
'form' => true,
'hidden' => true,
'lang' => true,
'multiple' => true,
'name' => true,
'onblur' => true,
'onchange' => true,
'oncontextmenu' => true,
'onfocus' => true,
'oninput' => true,
'oninvalid' => true,
'onreset' => true,
'onsearch' => true,
'onselect' => true,
'onsubmit' => true,
'required' => true,
'size' => true,
'spellcheck' => true,
'tabindex' => true,
'translate' => true,
),
'option' => array(
'class' => true,
'disabled' => true,
'id' => true,
'label' => true,
'selected' => true,
'value' => true,
),
);
// Add the global allowed attributes to each html element.
$input_tags = array_map( '_wp_add_global_attributes', $input_tags );
}
return array_merge_recursive( $allowed_post_tags, $input_tags );
}
/**
* Gets an array of enabled features.
*
* @return string[] The array of enabled features.
*/
public static function retrieve_enabled_features() {
$enabled_features = array();
if ( defined( 'YOAST_SEO_ENABLED_FEATURES' ) ) {
$enabled_features = preg_split( '/,\W*/', YOAST_SEO_ENABLED_FEATURES );
}
// Make the array of enabled features filterable, so features can be enabled at will.
$enabled_features = apply_filters( 'wpseo_enable_feature', $enabled_features );
return $enabled_features;
}
/* ********************* DEPRECATED METHODS ********************* */
/**
* Returns the language part of a given locale, defaults to english when the $locale is empty.
*
* @see WPSEO_Language_Utils::get_language()
*
* @deprecated 9.5
* @codeCoverageIgnore
*
* @param string $locale The locale to get the language of.
*
* @return string The language part of the locale.
*/
public static function get_language( $locale ) {
_deprecated_function( __METHOD__, 'WPSEO 9.5', 'WPSEO_Language_Utils::get_language' );
return WPSEO_Language_Utils::get_language( $locale );
}
/**
* 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.
*
* @see WPSEO_Language_Utils::get_user_locale()
*
* @deprecated 9.5
* @codeCoverageIgnore
*
* @return string The locale.
*/
public static function get_user_locale() {
_deprecated_function( __METHOD__, 'WPSEO 9.5', 'WPSEO_Language_Utils::get_user_locale' );
return WPSEO_Language_Utils::get_user_locale();
}
}