ROR. * 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(); } }