PluginProbe
ThinkRank AI SEO – AI SEO Plugin for WordPress: Schema, XML Sitemaps, Meta Tags, Search Console & Local SEO / 2.11.0
ThinkRank AI SEO – AI SEO Plugin for WordPress: Schema, XML Sitemaps, Meta Tags, Search Console & Local SEO v2.11.0
2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.1 2.1.0 2.0.2 2.0.1 2.0.0 1.32.0 1.31.0 1.30.0 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 trunk 1.0.0 All 52 releases
← All changes | includes/seo/class-site-identity-manager.php +328 -37 2.6.0 → 2.11.0 View file →
@@ -40,8 +40,36 @@
40 40 */
41 41 class Site_Identity_Manager extends Abstract_SEO_Manager {
42 42
43 43 /**
44 + * The per-context title formats as ThinkRank ships them.
45 + *
46 + * These are not in get_default_settings(): the admin screen seeds them on
47 + * first save, so on a real install they are stored values, indistinguishable
48 + * from a template the user typed. The migration needs to tell those two
49 + * apart — it may overwrite a shipped default with an imported template, and
50 + * must never overwrite a choice the user made — so this is the record of
51 + * what "untouched" looks like.
52 + *
53 + * Keep in step with getDefaultSettings() in
54 + * src/admin/components/essential-seo/SiteIdentityTab.js. SiteIdentityTitleFormatDefaultsTest
55 + * fails when the two drift.
56 + *
57 + * @since 2.8.0
58 + * @var array<string, string>
59 + */
60 + public const TITLE_FORMAT_DEFAULTS = [
61 + 'homepage_title' => '%site_title% %sep% %site_description%',
62 + 'post_title' => '%post_title% %sep% %site_title%',
63 + 'page_title' => '%page_title% %sep% %site_title%',
64 + 'category_title' => '%category_title% %sep% %site_title%',
65 + 'tag_title' => '%tag_title% %sep% %site_title%',
66 + 'author_title' => '%author_name% %sep% %site_title%',
67 + 'search_title' => 'Search Results for "%search_term%" %sep% %site_title%',
68 + 'archive_title' => '%archive_title% %sep% %site_title%',
69 + ];
70 +
71 + /**
44 72 * WordPress filesystem instance
45 73 *
46 74 * @since 1.0.0
47 75 * @var \WP_Filesystem_Base|null
@@ -303,8 +331,91 @@
303 331 }
304 332 }
305 333
306 334 /**
335 + * Save settings, then refresh what a new canonical scheme invalidates.
336 + *
337 + * The static sitemap files are written with the scheme in force when they
338 + * were built, and nothing else rebuilds them until a post or term changes.
339 + * So a change of scheme left every `<loc>` on the old one while canonical
340 + * and og:url had already moved (#736). Every writer (the settings route,
341 + * the robots route, the MCP abilities, an import) lands here.
342 + *
343 + * @since 2.7.0
344 + *
345 + * @param string $context_type Context type.
346 + * @param int|null $context_id Context ID.
347 + * @param array $settings Settings to save.
348 + * @return bool
349 + */
350 + public function save_settings(string $context_type, ?int $context_id, array $settings): bool {
351 + if (!self::touches_canonical_scheme($context_type, $context_id, $settings)) {
352 + return parent::save_settings($context_type, $context_id, $settings);
353 + }
354 +
355 + $before = Url_Scheme::preference();
356 + $saved = parent::save_settings($context_type, $context_id, $settings);
357 +
358 + if ($saved) {
359 + $this->on_canonical_scheme_saved($before);
360 + }
361 +
362 + return $saved;
363 + }
364 +
365 + /**
366 + * Whether a save can change the site-wide canonical scheme.
367 + *
368 + * @since 2.7.0
369 + *
370 + * @param string $context_type Context type.
371 + * @param int|null $context_id Context ID.
372 + * @param array $settings Settings being saved.
373 + * @return bool
374 + */
375 + public static function touches_canonical_scheme(string $context_type, ?int $context_id, array $settings): bool {
376 + return 'site' === sanitize_key($context_type)
377 + && empty($context_id)
378 + && array_key_exists('canonical_scheme', $settings);
379 + }
380 +
381 + /**
382 + * Rebuild the static sitemaps when the effective scheme changed.
383 + *
384 + * Compares the effective preference, filter included, so a site whose
385 + * scheme is pinned by `thinkrank_canonical_scheme` does not rebuild on a
386 + * stored value that changes nothing it publishes.
387 + *
388 + * @since 2.7.0
389 + *
390 + * @param string $before Effective scheme before the save.
391 + * @return void
392 + */
393 + protected function on_canonical_scheme_saved(string $before): void {
394 + // The preference is cached for the request; the save just changed it.
395 + Url_Scheme::reset();
396 +
397 + if (Url_Scheme::preference() === $before) {
398 + return;
399 + }
400 +
401 + $this->schedule_sitemap_rebuild();
402 + }
403 +
404 + /**
405 + * Queue a settings-driven sitemap rebuild.
406 + *
407 + * Debounced and run after the response, like any other settings change
408 + * that alters what the sitemap publishes.
409 + *
410 + * @since 2.7.0
411 + * @return void
412 + */
413 + protected function schedule_sitemap_rebuild(): void {
414 + (new Sitemap_Generator(false))->schedule_regeneration();
415 + }
416 +
417 + /**
307 418 * Build the icon derivatives for a newly chosen favicon.
308 419 *
309 420 * Runs on save, which is the only moment the choice changes and the only
310 421 * place image work belongs — resolving a size on the front end must stay a
@@ -1178,17 +1289,19 @@
1178 1289 $home_text = $settings['breadcrumb_home_text'] ?? 'Home';
1179 1290 if (empty($home_text)) {
1180 1291 $optimization['warnings'][] = 'Empty home text reduces accessibility for screen readers';
1181 1292 $optimization['score'] -= 15;
1182 - } elseif (strlen($home_text) > 20) {
1183 - $optimization['suggestions'][] = 'Keep home text concise (current: ' . strlen($home_text) . ' chars)';
1293 + } elseif (mb_strlen($home_text) > 20) {
1294 + // mb_strlen: this number is shown to the user as "chars" (#687).
1295 + $optimization['suggestions'][] = 'Keep home text concise (current: ' . mb_strlen($home_text) . ' chars)';
1184 1296 $optimization['score'] -= 5;
1185 1297 }
1186 1298
1187 1299 // Check prefix usage
1188 1300 $prefix = $settings['breadcrumb_prefix'] ?? '';
1189 - if (!empty($prefix) && strlen($prefix) > 50) {
1190 - $optimization['suggestions'][] = 'Breadcrumb prefix is quite long (' . strlen($prefix) . ' chars) - consider shortening';
1301 + if (!empty($prefix) && mb_strlen($prefix) > 50) {
1302 + // mb_strlen: this number is shown to the user as "chars" (#687).
1303 + $optimization['suggestions'][] = 'Breadcrumb prefix is quite long (' . mb_strlen($prefix) . ' chars) - consider shortening';
1191 1304 $optimization['score'] -= 5;
1192 1305 }
1193 1306
1194 1307 // Current page display
@@ -1428,11 +1541,12 @@
1428 1541 $optimization['score'] -= 15;
1429 1542 }
1430 1543 }
1431 1544
1432 - // Business type validation
1433 - if (empty($settings['business_type'])) {
1434 - $optimization['suggestions'][] = 'Select a specific business type for better schema markup';
1545 + // Business type validation (shared rule, one message — #622).
1546 + $business_type = $this->business_type_status($settings);
1547 + if ('suggestion' === $business_type['status']) {
1548 + $optimization['suggestions'][] = $business_type['message'];
1435 1549 $optimization['score'] -= 5;
1436 1550 }
1437 1551
1438 1552 // Email validation
@@ -1962,24 +2076,17 @@
1962 2076 'icon' => '✗'
1963 2077 ];
1964 2078 }
1965 2079
1966 - // Business Type validation
1967 - if (!empty($settings['business_type']) && $settings['business_type'] !== 'LocalBusiness') {
1968 - $field_details[] = [
1969 - 'field' => 'business_type',
1970 - 'label' => 'Business type is selected for proper schema markup.',
1971 - 'status' => 'valid',
1972 - 'icon' => '✓'
1973 - ];
1974 - } else {
1975 - $field_details[] = [
1976 - 'field' => 'business_type',
1977 - 'label' => 'Specific business type selection recommended for better schema markup.',
1978 - 'status' => 'suggestion',
1979 - 'icon' => '⚠'
1980 - ];
1981 - }
2080 + // Business Type validation — see business_type_status() for why there
2081 + // is exactly one rule here now (#622).
2082 + $business_type = $this->business_type_status($settings);
2083 + $field_details[] = [
2084 + 'field' => 'business_type',
2085 + 'label' => $business_type['message'],
2086 + 'status' => $business_type['status'],
2087 + 'icon' => 'valid' === $business_type['status'] ? '✓' : '⚠',
2088 + ];
1982 2089
1983 2090 // Address validation (NAP consistency)
1984 2091 $address_fields = ['business_address', 'business_city', 'business_state', 'business_country'];
1985 2092 $address_complete = true;
@@ -2663,11 +2770,15 @@
2663 2770 } else {
2664 2771 $validation['suggestions'][] = 'Add business hours to improve local search visibility';
2665 2772 }
2666 2773
2667 - // Validate business type
2668 - if (empty($settings['business_type'])) {
2669 - $validation['suggestions'][] = 'Select a specific business type for better schema markup';
2774 + // Business type, through the shared rule (#622). This is the only place
2775 + // it is reported on the generic path: validate_settings() with no tab
2776 + // context attaches basic-info field details, not business-info ones, so
2777 + // without this the setting would go unreported there entirely.
2778 + $business_type = $this->business_type_status($settings);
2779 + if ('suggestion' === $business_type['status']) {
2780 + $validation['suggestions'][] = $business_type['message'];
2670 2781 }
2671 2782
2672 2783 return $validation;
2673 2784 }
@@ -2759,8 +2870,47 @@
2759 2870 * @since 2.0.1
2760 2871 *
2761 2872 * @return string[]
2762 2873 */
2874 + /**
2875 + * The stored alternate name(s), shaped for schema output.
2876 + *
2877 + * schema.org and Google both allow `alternateName` to carry one value or
2878 + * several, and the store already round-trips either shape, so this accepts
2879 + * both and normalises: null when there is nothing to publish, a bare string
2880 + * for one name, a list for more. Emitting a one-element array would be
2881 + * valid but noisier than it needs to be.
2882 + *
2883 + * Shared because both WebSite producers need it and must agree — a property
2884 + * added to one and not the other is how #688 happened.
2885 + *
2886 + * @since 2.7.0
2887 + *
2888 + * @param mixed $value Stored alternate_name value.
2889 + * @return string|string[]|null
2890 + */
2891 + public static function alternate_name_for_schema($value) {
2892 + $names = [];
2893 +
2894 + foreach ((array) $value as $name) {
2895 + if (!is_scalar($name)) {
2896 + continue;
2897 + }
2898 +
2899 + $name = trim((string) $name);
2900 +
2901 + if ('' !== $name && !in_array($name, $names, true)) {
2902 + $names[] = $name;
2903 + }
2904 + }
2905 +
2906 + if (empty($names)) {
2907 + return null;
2908 + }
2909 +
2910 + return 1 === count($names) ? $names[0] : $names;
2911 + }
2912 +
2763 2913 protected function additional_setting_keys(): array {
2764 2914 return [
2765 2915 // Title formats, one per context.
2766 2916 'homepage_title', 'post_title', 'page_title', 'category_title',
@@ -2811,12 +2961,96 @@
2811 2961 if (array_key_exists('ai_crawler_rules', $sanitized)) {
2812 2962 $sanitized['ai_crawler_rules'] = AI_Crawlers::normalize_rules($sanitized['ai_crawler_rules']);
2813 2963 }
2814 2964
2965 + // Same reasoning one key up, for the scheme override (#638). Anything
2966 + // that is not one of the three modes means "follow WordPress", and is
2967 + // stored as that rather than kept verbatim — otherwise get-site-identity
2968 + // -settings would report a scheme the site does not actually publish.
2969 + if (array_key_exists('canonical_scheme', $sanitized)) {
2970 + $sanitized['canonical_scheme'] = in_array($sanitized['canonical_scheme'], Url_Scheme::MODES, true)
2971 + ? $sanitized['canonical_scheme']
2972 + : Url_Scheme::AUTOMATIC;
2973 + }
2974 +
2975 + // Same reasoning again for the business type. It goes straight into
2976 + // LocalBusiness schema, so a type that is not in the schema.org
2977 + // vocabulary is invalid structured data — and storing it verbatim would
2978 + // have get-site-identity-settings report a type the site cannot
2979 + // actually publish. An empty value keeps meaning "not set"; anything
2980 + // else unrecognised falls back to the general-purpose root (#623).
2981 + if (array_key_exists('business_type', $sanitized)) {
2982 + $type = (string) $sanitized['business_type'];
2983 +
2984 + if ('' !== $type && !\ThinkRank\Config\Local_Business_Types_Config::is_valid($type)) {
2985 + $type = \ThinkRank\Config\Local_Business_Types_Config::ROOT;
2986 + }
2987 +
2988 + $sanitized['business_type'] = $type;
2989 + }
2990 +
2815 2991 return $sanitized;
2816 2992 }
2817 2993
2818 2994 /**
2995 + * schema.org's general-purpose LocalBusiness type.
2996 + *
2997 + * The default, the first option in the control, and a valid answer in its
2998 + * own right — which is the whole point of #622.
2999 + *
3000 + * @since 2.10.0
3001 + * @var string
3002 + */
3003 + private const GENERAL_BUSINESS_TYPE = 'LocalBusiness';
3004 +
3005 + /**
3006 + * The one rule for whether a business type needs the user's attention.
3007 + *
3008 + * There were three, with two wordings and two different conditions. Two
3009 + * fired when the value was empty; the third fired when it WAS
3010 + * `LocalBusiness` — which is the default, the first option in the control
3011 + * and a perfectly valid schema.org type. So the warning appeared out of the
3012 + * box for every site, could not be cleared without choosing a type that
3013 + * might be inaccurate, and on an empty value it appeared three times in two
3014 + * different phrasings, which is why it was reported as showing twice (#622).
3015 + *
3016 + * The rule now: a type is expected, and any type in the vocabulary is a
3017 + * correct answer. Only an unset value is worth prompting about.
3018 + * `LocalBusiness` is the general-purpose answer and is accepted as one —
3019 + * with a note that a more specific type sharpens the schema, phrased as the
3020 + * guidance it is rather than as a fault the user has to clear.
3021 + *
3022 + * @since 2.10.0
3023 + *
3024 + * @param array $settings Site identity settings.
3025 + * @return array{status:string,message:string} `valid` or `suggestion`.
3026 + */
3027 + private function business_type_status(array $settings): array {
3028 + $type = trim((string) ($settings['business_type'] ?? ''));
3029 +
3030 + if ('' === $type) {
3031 + return [
3032 + 'status' => 'suggestion',
3033 + 'message' => __('Select a business type so your local schema describes the right kind of business.', 'thinkrank'),
3034 + ];
3035 + }
3036 +
3037 + // The literal rather than a constant from the expanded type list (#623):
3038 + // that lands on its own branch, and this fix must not wait on it.
3039 + if (self::GENERAL_BUSINESS_TYPE === $type) {
3040 + return [
3041 + 'status' => 'valid',
3042 + 'message' => __('Business type is set to Local Business. A more specific type sharpens your schema, if one fits.', 'thinkrank'),
3043 + ];
3044 + }
3045 +
3046 + return [
3047 + 'status' => 'valid',
3048 + 'message' => __('Business type is selected for proper schema markup.', 'thinkrank'),
3049 + ];
3050 + }
3051 +
3052 + /**
2819 3053 * Get default settings for a context type (implements interface)
2820 3054 *
2821 3055 * @since 1.0.0
2822 3056 *
@@ -2836,8 +3070,27 @@
2836 3070 'breadcrumb_home_text' => 'Home',
2837 3071 'breadcrumb_separator' => '>',
2838 3072 'robots_txt_enabled' => true,
2839 3073 'allow_search_engines' => true,
3074 + // Answer 404 when a content selector in the URL resolved to
3075 + // nothing (#634). On by default, unlike the other new settings
3076 + // here: it changes no URL a visitor or a correct crawler uses, only
3077 + // ones where WordPress resolved nothing and served the blog listing
3078 + // at 200 anyway.
3079 + 'query_protection' => true,
3080 +
3081 + // Feed controls (#635). All three off, so an upgrade changes
3082 + // nothing about what an existing site already sends its
3083 + // subscribers; a brand-new install is seeded with the signature and
3084 + // the noindex on, in Activator::seed_feed_defaults().
3085 + 'feed_excerpt_only' => false,
3086 + 'feed_source_link' => false,
3087 + 'feed_noindex' => false,
3088 +
3089 + // The scheme self-referential URLs go out with (#638). 'automatic'
3090 + // means substitute nothing and follow WordPress, which is what
3091 + // every site did before the setting existed.
3092 + 'canonical_scheme' => Url_Scheme::AUTOMATIC,
2840 3093 'robots_txt_content' => '',
2841 3094 // Empty map = every AI crawler allowed. Defaults must stay
2842 3095 // permissive so an upgrade never starts blocking a crawler a site
2843 3096 // was happily serving (#657).
@@ -3051,16 +3304,17 @@
3051 3304 // Remove extra whitespace
3052 3305 $title = preg_replace('/\s+/', ' ', $title);
3053 3306 $title = trim($title);
3054 3307
3055 - // Ensure title is not too long (60 characters max for SEO)
3056 - if (strlen($title) > 60) {
3057 - // Try to truncate at word boundary
3058 - $title = wp_trim_words($title, 8, '...');
3059 - if (strlen($title) > 60) {
3060 - $title = substr($title, 0, 57) . '...';
3061 - }
3062 - }
3308 + // Ensure title is not too long (60 characters max for SEO).
3309 + // All three units here were wrong for non-Latin text: strlen() counts
3310 + // BYTES so the gate fired at 20 Thai characters, wp_trim_words() counts
3311 + // CHARACTERS on th/ja/zh_* so `8` cut the title to 8 of them, and
3312 + // substr() cuts bytes so it split a character mid-sequence (#687).
3313 + $title = \ThinkRank\Core\Seo_Text::trim_to_length(
3314 + $title,
3315 + \ThinkRank\Core\Seo_Text::TITLE_MAX_LENGTH
3316 + );
3063 3317
3064 3318 // Ensure title is not empty
3065 3319 if (empty($title)) {
3066 3320 $title = get_bloginfo('name');
@@ -3450,8 +3704,29 @@
3450 3704 * @since 1.0.0
3451 3705 * @return array Array of sitemap URLs
3452 3706 */
3453 3707 private function get_sitemap_urls_for_robots(): array {
3708 + // One wrapper over every return path below, including the #104 extras.
3709 + // The Sitemap: line is the only absolute URL of ours in robots.txt and
3710 + // the one a crawler follows to find everything else, so it has to carry
3711 + // the site's scheme preference (#638). Applied here rather than where
3712 + // the body is assembled, because that path also renders a robots.txt a
3713 + // site owner typed themselves, and their text is not ours to rewrite.
3714 + return array_map(
3715 + static function (string $url): string {
3716 + return Url_Scheme::apply($url);
3717 + },
3718 + $this->collect_sitemap_urls_for_robots()
3719 + );
3720 + }
3721 +
3722 + /**
3723 + * The sitemap URLs robots.txt advertises, before the scheme preference.
3724 + *
3725 + * @since 1.0.0
3726 + * @return array Array of sitemap URLs
3727 + */
3728 + private function collect_sitemap_urls_for_robots(): array {
3454 3729 try {
3455 3730 // Get sitemap settings
3456 3731 $sitemap_generator = new \ThinkRank\SEO\Sitemap_Generator();
3457 3732 $sitemap_settings = $sitemap_generator->get_settings('site');
@@ -3500,9 +3775,22 @@
3500 3775 // business sitemap and the sitemaps other plugins register both land
3501 3776 // here for the same reason, so they go through one list (#104).
3502 3777 $extra = [];
3503 3778
3504 - if (file_exists(ABSPATH . 'local-sitemap.xml')) {
3779 + // Not a file test. Under dynamic delivery the local sitemap is
3780 + // served from PHP and no file is ever written, so file_exists()
3781 + // silently dropped a sitemap the site really does publish (#752).
3782 + // On static sites the file is still what proves it, so both count.
3783 + $local_sitemap_published = file_exists(ABSPATH . 'local-sitemap.xml');
3784 +
3785 + if (!$local_sitemap_published && class_exists('ThinkRank\\SEO\\Sitemap_Generator')) {
3786 + $generator = new \ThinkRank\SEO\Sitemap_Generator(false);
3787 +
3788 + $local_sitemap_published = 'dynamic' === $generator->resolve_delivery_mode()
3789 + && $generator->publishes_local_sitemap();
3790 + }
3791 +
3792 + if ($local_sitemap_published) {
3505 3793 $extra[] = '/local-sitemap.xml';
3506 3794 }
3507 3795
3508 3796 foreach (\ThinkRank\SEO\Sitemap_Generator::additional_sitemaps() as $path) {
@@ -3927,11 +4215,14 @@
3927 4215 $optimization['validation']['valid'] = false;
3928 4216 }
3929 4217
3930 4218 if (!empty($value) && isset($config['max_length'])) {
3931 - if (strlen($value) > $config['max_length']) {
4219 + // The warning says "characters", so measure and cut in characters:
4220 + // strlen()/substr() fired early on non-Latin values and the
4221 + // suggested replacement was cut mid-character (#687).
4222 + if (mb_strlen($value) > $config['max_length']) {
3932 4223 $optimization['validation']['warnings'][] = "{$element} exceeds maximum length of {$config['max_length']} characters";
3933 - $optimization['optimized_value'] = substr($value, 0, $config['max_length']);
4224 + $optimization['optimized_value'] = \ThinkRank\Core\Seo_Text::trim_to_length($value, (int) $config['max_length']);
3934 4225 }
3935 4226 }
3936 4227
3937 4228 // SEO-specific optimizations