Merge branch 'trunk' of https://github.com/Yoast/wordpress-seo into PC-965-yoast-markers-break-html-of-content

Author: marinakoleva

admin/class-admin.php

@@ -252,7 +252,7 @@ public function add_action_link( $links, $file ) {
 		}
 
 		// Add link to premium landing page.
-		$premium_link = '<a style="font-weight: bold;" href="' . esc_url( WPSEO_Shortlinker::get( 'https://yoa.st/1yb' ) ) . '" target="_blank">' . __( 'Get Premium', 'wordpress-seo' ) . '</a>';
+		$premium_link = '<a style="font-weight: bold;" href="' . esc_url( WPSEO_Shortlinker::get( 'https://yoa.st/1yb' ) ) . '" target="_blank" data-action="load-nfd-ctb" data-ctb-id="57d6a568-783c-45e2-a388-847cff155897">' . __( 'Get Premium', 'wordpress-seo' ) . '</a>';
 		array_unshift( $links, $premium_link );
 
 		return $links;

inc/class-wpseo-admin-bar-menu.php

@@ -5,7 +5,6 @@
  * @package WPSEO
  */
 
-use WPSEO_Shortlinker;
 use Yoast\WP\SEO\Helpers\Product_Helper;
 use Yoast\WP\SEO\Helpers\Score_Icon_Helper;
 use Yoast\WP\SEO\Models\Indexable;
@@ -80,6 +79,13 @@ class WPSEO_Admin_Bar_Menu implements WPSEO_WordPress_Integration {
 	 */
 	protected $product_helper;
 
+	/**
+	 * Holds the shortlinker instance.
+	 *
+	 * @var WPSEO_Shortlinker
+	 */
+	protected $shortlinker;
+
 	/**
 	 * Whether SEO Score is enabled.
 	 *
@@ -108,12 +114,14 @@ class WPSEO_Admin_Bar_Menu implements WPSEO_WordPress_Integration {
 	 * @param Indexable_Repository|null      $indexable_repository Optional. The Indexable_Repository.
 	 * @param Score_Icon_Helper|null         $score_icon_helper    Optional. The Score_Icon_Helper.
 	 * @param Product_Helper|null            $product_helper       Optional. The product helper.
+	 * @param WPSEO_Shortlinker|null         $shortlinker          The shortlinker.
 	 */
 	public function __construct(
 		WPSEO_Admin_Asset_Manager $asset_manager = null,
 		Indexable_Repository $indexable_repository = null,
 		Score_Icon_Helper $score_icon_helper = null,
-		Product_Helper $product_helper = null
+		Product_Helper $product_helper = null,
+		WPSEO_Shortlinker $shortlinker = null
 	) {
 		if ( ! $asset_manager ) {
 			$asset_manager = new WPSEO_Admin_Asset_Manager();
@@ -127,11 +135,15 @@ public function __construct(
 		if ( ! $product_helper ) {
 			$product_helper = YoastSEO()->helpers->product;
 		}
+		if ( ! $shortlinker ) {
+			$shortlinker = new WPSEO_Shortlinker();
+		}
 
 		$this->product_helper       = $product_helper;
 		$this->asset_manager        = $asset_manager;
 		$this->indexable_repository = $indexable_repository;
 		$this->score_icon_helper    = $score_icon_helper;
+		$this->shortlinker          = $shortlinker;
 	}
 
 	/**
@@ -246,7 +258,7 @@ public function add_menu( WP_Admin_Bar $wp_admin_bar ) {
 						[
 							'parent' => self::MENU_IDENTIFIER,
 							'id'     => 'wpseo-frontend-inspector',
-							'href'   => 'https://yoa.st/admin-bar-frontend-inspector',
+							'href'   => $this->shortlinker->build_shortlink( 'https://yoa.st/admin-bar-frontend-inspector' ),
 							'title'  => __( 'Front-end SEO inspector', 'wordpress-seo' ) . new Premium_Badge_Presenter( 'wpseo-frontend-inspector-badge' ),
 							'meta'   => [
 								'tabindex' => '0',
@@ -461,17 +473,17 @@ protected function add_seo_tools_submenu( WP_Admin_Bar $wp_admin_bar ) {
 			[
 				'id'    => 'wpseo-semrush',
 				'title' => 'Semrush',
-				'href'  => WPSEO_Shortlinker::get( 'https://yoa.st/admin-bar-semrush' ),
+				'href'  => $this->shortlinker->build_shortlink( 'https://yoa.st/admin-bar-semrush' ),
 			],
 			[
 				'id'    => 'wpseo-wincher',
 				'title' => 'Wincher',
-				'href'  => WPSEO_Shortlinker::get( 'https://yoa.st/admin-bar-wincher' ),
+				'href'  => $this->shortlinker->build_shortlink( 'https://yoa.st/admin-bar-wincher' ),
 			],
 			[
 				'id'    => 'wpseo-google-trends',
 				'title' => 'Google trends',
-				'href'  => WPSEO_Shortlinker::get( 'https://yoa.st/admin-bar-gtrends' ),
+				'href'  => $this->shortlinker->build_shortlink( 'https://yoa.st/admin-bar-gtrends' ),
 			],
 		];
 
@@ -498,17 +510,17 @@ protected function add_how_to_submenu( WP_Admin_Bar $wp_admin_bar ) {
 			[
 				'id'    => 'wpseo-learn-seo',
 				'title' => __( 'Learn more SEO', 'wordpress-seo' ),
-				'href'  => WPSEO_Shortlinker::get( 'https://yoa.st/admin-bar-learn-more-seo' ),
+				'href'  => $this->shortlinker->build_shortlink( 'https://yoa.st/admin-bar-learn-more-seo' ),
 			],
 			[
 				'id'    => 'wpseo-improve-blogpost',
 				'title' => __( 'Improve your blog post', 'wordpress-seo' ),
-				'href'  => WPSEO_Shortlinker::get( 'https://yoa.st/admin-bar-improve-blog-post' ),
+				'href'  => $this->shortlinker->build_shortlink( 'https://yoa.st/admin-bar-improve-blog-post' ),
 			],
 			[
 				'id'    => 'wpseo-write-better-content',
 				'title' => __( 'Write better content', 'wordpress-seo' ),
-				'href'  => WPSEO_Shortlinker::get( 'https://yoa.st/admin-bar-write-better' ),
+				'href'  => $this->shortlinker->build_shortlink( 'https://yoa.st/admin-bar-write-better' ),
 			],
 		];
 
@@ -535,22 +547,22 @@ protected function add_get_help_submenu( WP_Admin_Bar $wp_admin_bar ) {
 			[
 				'id'    => 'wpseo-yoast-help',
 				'title' => __( 'Yoast.com help section', 'wordpress-seo' ),
-				'href'  => WPSEO_Shortlinker::get( 'https://yoa.st/admin-bar-yoast-help' ),
+				'href'  => $this->shortlinker->build_shortlink( 'https://yoa.st/admin-bar-yoast-help' ),
 			],
 			[
 				'id'    => 'wpseo-premium-support',
 				'title' => __( 'Yoast Premium support', 'wordpress-seo' ),
-				'href'  => WPSEO_Shortlinker::get( 'https://yoa.st/admin-bar-premium-support' ),
+				'href'  => $this->shortlinker->build_shortlink( 'https://yoa.st/admin-bar-premium-support' ),
 			],
 			[
 				'id'    => 'wpseo-wp-support-forums',
 				'title' => __( 'WordPress.org support forums', 'wordpress-seo' ),
-				'href'  => WPSEO_Shortlinker::get( 'https://yoa.st/admin-bar-wp-support-forums' ),
+				'href'  => $this->shortlinker->build_shortlink( 'https://yoa.st/admin-bar-wp-support-forums' ),
 			],
 			[
 				'id'    => 'wpseo-learn-seo-2',
 				'title' => __( 'Learn more SEO', 'wordpress-seo' ),
-				'href'  => WPSEO_Shortlinker::get( 'https://yoa.st/admin-bar-learn-more-seo-help' ),
+				'href'  => $this->shortlinker->build_shortlink( 'https://yoa.st/admin-bar-learn-more-seo-help' ),
 			],
 		];
 
@@ -569,11 +581,14 @@ protected function add_premium_link( WP_Admin_Bar $wp_admin_bar ) {
 			[
 				'parent' => self::MENU_IDENTIFIER,
 				'id'     => 'wpseo-get-premium',
-				'title'  => __( 'Get Yoast SEO Premium', 'wordpress-seo' ) . ' »',
-				'href'   => WPSEO_Shortlinker::get( 'https://yoa.st/admin-bar-get-premium' ),
+				// Circumvent an issue in the WP admin bar API in order to pass `data` attributes. See https://core.trac.wordpress.org/ticket/38636.
+				'title'  => sprintf(
+					'<a href="%1$s" target="_blank" data-action="load-nfd-ctb" data-ctb-id="57d6a568-783c-45e2-a388-847cff155897" style="padding:0;">%2$s &raquo;</a>',
+					$this->shortlinker->build_shortlink( 'https://yoa.st/admin-bar-get-premium' ),
+					__( 'Get Yoast SEO Premium', 'wordpress-seo' )
+				),
 				'meta'   => [
 					'tabindex' => '0',
-					'target'   => '_blank',
 				],
 			]
 		);

package.json

@@ -84,7 +84,7 @@
     "typescript": "^4.2.4"
   },
   "yoast": {
-    "pluginVersion": "19.12-RC6"
+    "pluginVersion": "19.12-RC7"
   },
   "version": "0.0.0"
 }

packages/js/src/settings/components/search.js

@@ -9,6 +9,7 @@ import { debounce, first, groupBy, includes, isEmpty, map, max, reduce, split, t
 import PropTypes from "prop-types";
 import { useHotkeys } from "react-hotkeys-hook";
 import { useNavigate } from "react-router-dom";
+import { safeToLocaleLower } from "../helpers";
 import { useParsedUserAgent, useSelectSettings } from "../hooks";
 
 const QUERY_MIN_CHARS = 3;
@@ -37,6 +38,7 @@ const Search = () => {
 	// eslint-disable-next-line no-unused-vars
 	const [ isOpen, , , setOpen, setClose ] = useToggleState( false );
 	const [ query, setQuery ] = useState( "" );
+	const userLocale = useSelectSettings( "selectPreference", [], "userLocale" );
 	const queryableSearchIndex = useSelectSettings( "selectQueryableSearchIndex" );
 	const [ results, setResults ] = useState( [] );
 	const ariaSvgProps = useSvgAria();
@@ -77,8 +79,8 @@ const Search = () => {
 			return false;
 		}
 
-		// Split query into words.
-		const splitQuery = split( trimmedQuery, " " );
+		// Lowercase and split query into words.
+		const splitQuery = split( safeToLocaleLower( trimmedQuery, userLocale ), " " );
 
 		// Filter search index by split query and store number of hits.
 		// A hit is registered if a single word from split query in found in a fields keywords.
@@ -115,7 +117,7 @@ const Search = () => {
 		} );
 
 		setResults( sortedGroupedQueryResults );
-	}, 100 ), [ queryableSearchIndex ] );
+	}, 100 ), [ queryableSearchIndex, userLocale ] );
 
 	const handleQueryChange = useCallback( event => {
 		setQuery( event.target.value );

packages/js/src/settings/helpers/i18n.js

@@ -0,0 +1,14 @@
+/**
+ * Lowercase a string in a locale, but with invalid locale safety.
+ * @param {string} string The string to lowercase.
+ * @param {string} locale The locale string.
+ * @returns {string} The lower case string if locale is valid, the string if locale is invalid.
+ */
+export const safeToLocaleLower = ( string, locale ) => {
+	try {
+		return string.toLocaleLowerCase( locale );
+	} catch ( error ) {
+		console.error( error.message );
+		return string;
+	}
+};

packages/js/src/settings/helpers/index.js

@@ -1,3 +1,4 @@
+export * from "./i18n";
 export * from "./user-social-profiles";
 export * from "./search";
 export * from "./submit";

packages/js/src/settings/helpers/search.js

@@ -2,13 +2,16 @@
 import { __, sprintf } from "@wordpress/i18n";
 import { Code } from "@yoast/ui-library";
 import { createInterpolateElement } from "@wordpress/element";
-import { omit, reduce, times, toLower, filter, includes, isEmpty } from "lodash";
+import { omit, reduce, times, filter, includes, isEmpty } from "lodash";
+import { safeToLocaleLower } from "./i18n";
 
 /**
  * @param {Object} postType The post type.
+ * @param {Object} options The options.
+ * @param {string} options.userLocale The user locale string.
  * @returns {Object} The search index for the post type.
  */
-export const createPostTypeSearchIndex = ( { name, label, route, hasArchive } ) => ( {
+export const createPostTypeSearchIndex = ( { name, label, route, hasArchive }, { userLocale } ) => ( {
 	[ `title-${ name }` ]: {
 		route: `/post-type/${ route }`,
 		routeLabel: label,
@@ -30,7 +33,7 @@ export const createPostTypeSearchIndex = ( { name, label, route, hasArchive } )
 		fieldLabel: sprintf(
 			// translators: %1$s expands to the post type plural, e.g. Posts.
 			__( "Show %1$s in search results", "wordpress-seo" ),
-			toLower( label )
+			safeToLocaleLower( label, userLocale )
 		),
 		keywords: [],
 	},
@@ -120,7 +123,7 @@ export const createPostTypeSearchIndex = ( { name, label, route, hasArchive } )
 			fieldLabel: sprintf(
 				// translators: %1$s expands to the post type plural, e.g. Posts.
 				__( "Show the archive for %1$s in search results", "wordpress-seo" ),
-				toLower( label )
+				safeToLocaleLower( label, userLocale )
 			),
 			keywords: [],
 		},
@@ -150,9 +153,11 @@ export const createPostTypeSearchIndex = ( { name, label, route, hasArchive } )
 
 /**
  * @param {Object} taxonomy The taxonomy.
+ * @param {Object} options The options.
+ * @param {string} options.userLocale The user locale string.
  * @returns {Object} The search index for the taxonomy.
  */
-export const createTaxonomySearchIndex = ( { name, label, route } ) => ( {
+export const createTaxonomySearchIndex = ( { name, label, route }, { userLocale } ) => ( {
 	[ `title-tax-${ name }` ]: {
 		route: `/taxonomy/${ route }`,
 		routeLabel: label,
@@ -175,7 +180,7 @@ export const createTaxonomySearchIndex = ( { name, label, route } ) => ( {
 			/* translators: %1$s expands to "Yoast SEO". %2$s expands to the taxonomy plural, e.g. Categories. */
 			__( "Enable %1$s for %2$s", "wordpress-seo" ),
 			"Yoast SEO",
-			toLower( label )
+			safeToLocaleLower( label, userLocale )
 		),
 		keywords: [],
 	},
@@ -193,7 +198,7 @@ export const createTaxonomySearchIndex = ( { name, label, route } ) => ( {
 		fieldLabel: sprintf(
 			// translators: %1$s expands to the taxonomy plural, e.g. Categories.
 			__( "Show %1$s in search results", "wordpress-seo" ),
-			toLower( label )
+			safeToLocaleLower( label, userLocale )
 		),
 		keywords: [],
 	},
@@ -232,9 +237,11 @@ export const createTaxonomySearchIndex = ( { name, label, route } ) => ( {
 /**
  * @param {Object} postTypes The post types.
  * @param {Object} taxonomies The taxonomies.
+ * @param {Object} options The options.
+ * @param {string} options.userLocale The user locale string.
  * @returns {Object} The search index.
  */
-export const createSearchIndex = ( postTypes, taxonomies ) => ( {
+export const createSearchIndex = ( postTypes, taxonomies, { userLocale } = {} ) => ( {
 	blogdescription: {
 		route: "/site-basics",
 		routeLabel: __( "Site basics", "wordpress-seo" ),
@@ -751,7 +758,7 @@ export const createSearchIndex = ( postTypes, taxonomies ) => ( {
 					fieldId: `input-wpseo_titles-post_types-${ postType.name }-maintax`,
 					fieldLabel: createInterpolateElement(
 						// translators: %1$s expands to the post type plural, e.g. posts.
-						sprintf( __( "Breadcrumbs for %1$s<code />", "wordpress-seo" ), toLower( postType.label ) ),
+						sprintf( __( "Breadcrumbs for %1$s<code />", "wordpress-seo" ), safeToLocaleLower( postType.label, userLocale ) ),
 						{
 							code: <Code className="yst-ml-2 group-hover:yst-bg-primary-200 group-hover:yst-text-primary-800">{ postType.name }</Code>,
 						}
@@ -768,7 +775,7 @@ export const createSearchIndex = ( postTypes, taxonomies ) => ( {
 				fieldId: `input-wpseo_titles-taxonomy-${ taxonomy.name }-ptparent`,
 				fieldLabel: createInterpolateElement(
 					// translators: %1$s expands to the taxonomy plural, e.g. categories.
-					sprintf( __( "Breadcrumbs for %1$s<code />", "wordpress-seo" ), toLower( taxonomy.label ) ),
+					sprintf( __( "Breadcrumbs for %1$s<code />", "wordpress-seo" ), safeToLocaleLower( taxonomy.label, userLocale ) ),
 					{
 						code: <Code className="yst-ml-2 group-hover:yst-bg-primary-200 group-hover:yst-text-primary-800">{ taxonomy.name }</Code>,
 					}
@@ -1056,12 +1063,12 @@ export const createSearchIndex = ( postTypes, taxonomies ) => ( {
 		// Post types - Attachments are handled separately above.
 		...reduce( omit( postTypes, [ "attachment" ] ), ( acc, postType ) => ( {
 			...acc,
-			...createPostTypeSearchIndex( postType ),
+			...createPostTypeSearchIndex( postType, { userLocale } ),
 		} ), {} ),
 		// Taxonomies
 		...reduce( omit( taxonomies, [ "post_format" ] ), ( acc, taxonomy ) => ( {
 			...acc,
-			...createTaxonomySearchIndex( taxonomy ),
+			...createTaxonomySearchIndex( taxonomy, { userLocale } ),
 		} ), {} ),
 	},
 	wpseo_social: {

packages/js/src/settings/routes/author-archives.js

@@ -4,7 +4,6 @@ import { __, sprintf } from "@wordpress/i18n";
 import { Badge, Code, Link } from "@yoast/ui-library";
 import FeatureUpsell from "@yoast/ui-library/src/components/feature-upsell";
 import { useFormikContext } from "formik";
-import { toLower } from "lodash";
 import {
 	FieldsetLayout,
 	FormikFlippedToggleField,
@@ -14,6 +13,7 @@ import {
 	OpenGraphDisabledAlert,
 	RouteLayout,
 } from "../components";
+import { safeToLocaleLower } from "../helpers";
 import { withFormikDummyField } from "../hocs";
 import { useSelectSettings } from "../hooks";
 
@@ -25,8 +25,9 @@ const FormikReplacementVariableEditorFieldWithDummy = withFormikDummyField( Form
 const AuthorArchives = () => {
 	const label = __( "Author archives", "wordpress-seo" );
 	const singularLabel = __( "Author archive", "wordpress-seo" );
-	const labelLower = useMemo( () => toLower( label ), [ label ] );
-	const singularLabelLower = useMemo( () => toLower( singularLabel ), [ singularLabel ] );
+	const userLocale = useSelectSettings( "selectPreference", [], "userLocale" );
+	const labelLower = useMemo( () => safeToLocaleLower( label, userLocale ), [ label, userLocale ] );
+	const singularLabelLower = useMemo( () => safeToLocaleLower( singularLabel, userLocale ), [ singularLabel, userLocale ] );
 
 	const premiumUpsellConfig = useSelectSettings( "selectUpsellSettingsAsProps" );
 	const replacementVariables = useSelectSettings( "selectReplacementVariablesFor", [], "author_archives", "custom-post-type_archive" );

packages/js/src/settings/routes/date-archives.js

@@ -3,7 +3,6 @@ import { createInterpolateElement, useMemo } from "@wordpress/element";
 import { __, sprintf } from "@wordpress/i18n";
 import { Badge, Code, FeatureUpsell, Link } from "@yoast/ui-library";
 import { useFormikContext } from "formik";
-import { toLower } from "lodash";
 import {
 	FieldsetLayout,
 	FormikFlippedToggleField,
@@ -13,6 +12,7 @@ import {
 	OpenGraphDisabledAlert,
 	RouteLayout,
 } from "../components";
+import { safeToLocaleLower } from "../helpers";
 import { withFormikDummyField } from "../hocs";
 import { useSelectSettings } from "../hooks";
 
@@ -23,7 +23,8 @@ const FormikReplacementVariableEditorFieldWithDummy = withFormikDummyField( Form
  */
 const DateArchives = () => {
 	const label = __( "Date archives", "wordpress-seo" );
-	const labelLower = useMemo( () => toLower( label ), [ label ] );
+	const userLocale = useSelectSettings( "selectPreference", [], "userLocale" );
+	const labelLower = useMemo( () => safeToLocaleLower( label, userLocale ), [ label, userLocale ] );
 
 	const premiumUpsellConfig = useSelectSettings( "selectUpsellSettingsAsProps" );
 	const replacementVariables = useSelectSettings( "selectReplacementVariablesFor", [], "date_archive", "custom-post-type_archive" );