PluginProbe
ThinkRank AI SEO – AI SEO Plugin for WordPress: Schema, XML Sitemaps, Meta Tags, Search Console & Local SEO / 2.12.0
ThinkRank AI SEO – AI SEO Plugin for WordPress: Schema, XML Sitemaps, Meta Tags, Search Console & Local SEO v2.12.0
2.12.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 All 53 releases
← All changes | includes/seo/class-site-identity-manager.php +769 -53 2.2.0 → 2.12.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
@@ -245,13 +273,347 @@
245 273 * Constructor
246 274 *
247 275 * @since 1.0.0
248 276 */
277 + /**
278 + * The square derivatives wp_site_icon() asks for.
279 + *
280 + * Core generates these only through its own Site Icon crop flow, so an
281 + * image chosen as a ThinkRank favicon straight from the media library has
282 + * none of them and every sizes="" declaration is a near miss (#571).
283 + *
284 + * @since 2.3.1
285 + * @var int[]
286 + */
287 + public const ICON_SIZES = [32, 180, 192, 270];
288 +
289 + /**
290 + * Transient holding resolved icon URLs, keyed by configured URL and size.
291 + *
292 + * The site-icon filter runs in wp_head on every FRONT-END request, and
293 + * resolving a URL to its attachment costs an uncached postmeta query. The
294 + * mapping only changes when the icon setting does, so it is cached here and
295 + * dropped on save.
296 + *
297 + * @since 2.3.1
298 + * @var string
299 + */
300 + public const ICON_URL_TRANSIENT = 'thinkrank_site_icon_urls';
301 +
302 + /**
303 + * Marker for the one-time derivative backfill on existing installs.
304 + *
305 + * @since 2.3.1
306 + * @var string
307 + */
308 + public const ICON_BACKFILL_OPTION = 'thinkrank_site_icon_sizes_backfilled';
309 +
310 + /**
311 + * Whether the icon-derivative listener has been registered this request.
312 + *
313 + * Static because `thinkrank_seo_settings_saved` is a global hook — one
314 + * listener serves every instance, and this class is constructed on the
315 + * front end as well as in admin.
316 + *
317 + * @since 2.3.1
318 + * @var bool
319 + */
320 + private static bool $icon_sizes_listener_registered = false;
321 +
249 322 public function __construct() {
250 323 parent::__construct('site_identity');
324 +
325 + if (!self::$icon_sizes_listener_registered) {
326 + self::$icon_sizes_listener_registered = true;
327 + add_action('thinkrank_seo_settings_saved', [$this, 'generate_icon_sizes_on_save'], 10, 2);
328 + // Admin only: resizing is not front-end work, and admin traffic is
329 + // enough to run a one-time backfill promptly.
330 + add_action('admin_init', [self::class, 'maybe_backfill_icon_sizes']);
331 + }
251 332 }
252 333
253 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 + /**
418 + * Build the icon derivatives for a newly chosen favicon.
419 + *
420 + * Runs on save, which is the only moment the choice changes and the only
421 + * place image work belongs — resolving a size on the front end must stay a
422 + * lookup. Failure is silent by design: a missing derivative degrades to the
423 + * next best file, so a site whose host cannot resize still renders an icon.
424 + *
425 + * @since 2.3.1
426 + *
427 + * @param string $manager_type Settings category that was saved.
428 + * @param array $settings The settings that were written.
429 + * @return void
430 + */
431 + public function generate_icon_sizes_on_save(string $manager_type, array $settings): void {
432 + if ('site_identity' !== $manager_type) {
433 + return;
434 + }
435 +
436 + // The choice, or the derivatives behind it, may have just changed.
437 + delete_transient(self::ICON_URL_TRANSIENT);
438 +
439 + foreach (['favicon_url', 'apple_touch_icon_url'] as $key) {
440 + if (empty($settings[$key]) || !is_string($settings[$key])) {
441 + continue;
442 + }
443 +
444 + $attachment_id = self::icon_attachment_id($settings[$key]);
445 +
446 + if ($attachment_id) {
447 + self::ensure_icon_sizes($attachment_id);
448 + }
449 + }
450 +
451 + // Dropped again after the resizes finish. Resizing is not instant, and a
452 + // front-end request arriving mid-generation would otherwise repopulate
453 + // the transient with the pre-derivative URLs and pin them for the full
454 + // TTL — leaving the sizes= declarations untrue until the next save.
455 + delete_transient(self::ICON_URL_TRANSIENT);
456 + }
457 +
458 + /**
459 + * Build the derivatives for a site that configured its icons before this
460 + * existed.
461 + *
462 + * generate_icon_sizes_on_save() only fires on a settings write, so every
463 + * site with an icon already chosen would keep serving whatever
464 + * wp_get_attachment_image_url() could find — in practice the 150x150
465 + * thumbnail behind a sizes="32x32" declaration — until someone happened to
466 + * re-save Site Identity. That is the bug this is meant to fix, so the
467 + * derivatives are built once on upgrade instead of waiting for a save.
468 + *
469 + * Guarded by its own option rather than the plugin version so it runs once
470 + * and stays cheap: the check is a single autoloaded read on requests after
471 + * the first.
472 + *
473 + * @since 2.3.1
474 + *
475 + * @return void
476 + */
477 + public static function maybe_backfill_icon_sizes(): void {
478 + if (get_option(self::ICON_BACKFILL_OPTION)) {
479 + return;
480 + }
481 +
482 + // Written before the work, not after: a host that cannot resize must
483 + // not retry on every admin request forever.
484 + update_option(self::ICON_BACKFILL_OPTION, time(), true);
485 +
486 + $settings = (new self())->get_settings('site');
487 +
488 + if (!is_array($settings)) {
489 + return;
490 + }
491 +
492 + foreach (['favicon_url', 'apple_touch_icon_url'] as $key) {
493 + if (empty($settings[$key]) || !is_string($settings[$key])) {
494 + continue;
495 + }
496 +
497 + $attachment_id = self::icon_attachment_id($settings[$key]);
498 +
499 + if ($attachment_id) {
500 + self::ensure_icon_sizes($attachment_id);
501 + }
502 + }
503 +
504 + delete_transient(self::ICON_URL_TRANSIENT);
505 + }
506 +
507 + /**
508 + * Attachment ID behind a configured icon URL, or 0 when it is not ours.
509 + *
510 + * attachment_url_to_postid() matches _wp_attached_file, which holds the
511 + * ORIGINAL upload path, so the URL of a generated derivative
512 + * (`logo-512x512.png`) returns 0 — and that is exactly what the media
513 + * picker hands back when the user chooses a size. Attachment_Lookup falls
514 + * back to the original behind it; the fallback started here and moved
515 + * there when every other image lookup turned out to need it (#847).
516 + *
517 + * Shared with SEO_Manager's site-icon filter so both sides of the feature
518 + * agree on which attachment a configured URL means.
519 + *
520 + * @since 2.3.1
521 + *
522 + * @param string $url Configured icon URL.
523 + * @return int Attachment ID, or 0.
524 + */
525 + public static function icon_attachment_id(string $url): int {
526 + return Attachment_Lookup::id_from_url($url);
527 + }
528 +
529 + /**
530 + * Which ICON_SIZES derivatives this attachment still needs.
531 + *
532 + * Split out from the generation so the decision can be asserted on its
533 + * own: whether a size is skipped because it already exists or because it
534 + * would upscale is invisible once both answers are "nothing was built".
535 + *
536 + * A source is measured by its SHORTER edge — a 400x40 banner cannot yield
537 + * a true 192x192 — and anything reporting no dimensions at all (SVGs) is
538 + * left alone.
539 + *
540 + * @since 2.3.1
541 + *
542 + * @param array $meta Attachment metadata.
543 + * @return array<string, array{width: int, height: int, crop: bool}> Sizes to build.
544 + */
545 + public static function missing_icon_sizes(array $meta): array {
546 + $source = min((int) ($meta['width'] ?? 0), (int) ($meta['height'] ?? 0));
547 +
548 + if ($source < 1) {
549 + return [];
550 + }
551 +
552 + $wanted = [];
553 + foreach (self::ICON_SIZES as $size) {
554 + // Never upscale: a stretched source behind an accurate sizes=""
555 + // label is worse than the honest near miss it would replace.
556 + if (isset($meta['sizes']["site_icon-{$size}"]) || $size > $source) {
557 + continue;
558 + }
559 +
560 + $wanted["site_icon-{$size}"] = ['width' => $size, 'height' => $size, 'crop' => true];
561 + }
562 +
563 + return $wanted;
564 + }
565 +
566 + /**
567 + * Generate whatever ICON_SIZES derivatives this attachment is missing.
568 + *
569 + * Only the missing ones, and never one larger than the source: upscaling a
570 + * small favicon would put a blurrier file behind an accurate sizes="" label
571 + * than the honest near-miss it replaced.
572 + *
573 + * @since 2.3.1
574 + *
575 + * @param int $attachment_id Attachment to build derivatives for.
576 + * @return string[] Size names generated, empty when there was nothing to do.
577 + */
578 + public static function ensure_icon_sizes(int $attachment_id): array {
579 + $meta = wp_get_attachment_metadata($attachment_id);
580 +
581 + if (!is_array($meta)) {
582 + return [];
583 + }
584 +
585 + $wanted = self::missing_icon_sizes($meta);
586 +
587 + if (empty($wanted)) {
588 + return [];
589 + }
590 +
591 + $file = get_attached_file($attachment_id);
592 +
593 + if (!$file || !file_exists($file)) {
594 + return [];
595 + }
596 +
597 + $editor = wp_get_image_editor($file);
598 +
599 + if (is_wp_error($editor)) {
600 + return [];
601 + }
602 +
603 + $generated = $editor->multi_resize($wanted);
604 +
605 + if (empty($generated)) {
606 + return [];
607 + }
608 +
609 + $meta['sizes'] = array_merge($meta['sizes'] ?? [], $generated);
610 + wp_update_attachment_metadata($attachment_id, $meta);
611 +
612 + return array_keys($generated);
613 + }
614 +
615 + /**
254 616 * Initialize WordPress filesystem
255 617 *
256 618 * @since 1.0.0
257 619 * @return bool True if filesystem is initialized, false otherwise
@@ -447,8 +809,17 @@
447 809 $body = ($custom !== '' && !$fully_blocked)
448 810 ? $this->strip_robots_header($custom)
449 811 : trim($this->generate_robots_txt()['content']);
450 812
813 + // The per-agent AI directives are machine-owned, so they are composed
814 + // here rather than stored: the textarea holds the user's body, with
815 + // the fenced block stripped out of every read and re-applied on every
816 + // render. A site-wide block already disallows everyone, so adding the
817 + // per-agent group there would be noise restating the same refusal.
818 + if (!$fully_blocked) {
819 + $body = $this->apply_ai_crawler_block($body, $settings);
820 + }
821 +
451 822 if ($body === '') {
452 823 return '';
453 824 }
454 825
@@ -524,9 +895,12 @@
524 895 $settings = $this->get_settings('site');
525 896
526 897 // Compare bodies, not raw strings: the auto-generated header carries a
527 898 // regeneration timestamp that always differs and means nothing here.
528 - $served = $this->strip_robots_header($effective['content']);
899 + // The AI crawler block is composed at render time on both sides, so it
900 + // is identical by construction and comparing it would only ever report
901 + // a false drift the admin cannot act on.
902 + $served = $this->strip_ai_crawler_block($this->strip_robots_header($effective['content']));
529 903
530 904 // Measure against the body the editor is displaying — get_served_robots_body()
531 905 // — not against render_robots_txt(). Two things made the old comparison
532 906 // report "in sync" while the screen showed rules no crawler receives:
@@ -904,17 +1278,19 @@
904 1278 $home_text = $settings['breadcrumb_home_text'] ?? 'Home';
905 1279 if (empty($home_text)) {
906 1280 $optimization['warnings'][] = 'Empty home text reduces accessibility for screen readers';
907 1281 $optimization['score'] -= 15;
908 - } elseif (strlen($home_text) > 20) {
909 - $optimization['suggestions'][] = 'Keep home text concise (current: ' . strlen($home_text) . ' chars)';
1282 + } elseif (mb_strlen($home_text) > 20) {
1283 + // mb_strlen: this number is shown to the user as "chars" (#687).
1284 + $optimization['suggestions'][] = 'Keep home text concise (current: ' . mb_strlen($home_text) . ' chars)';
910 1285 $optimization['score'] -= 5;
911 1286 }
912 1287
913 1288 // Check prefix usage
914 1289 $prefix = $settings['breadcrumb_prefix'] ?? '';
915 - if (!empty($prefix) && strlen($prefix) > 50) {
916 - $optimization['suggestions'][] = 'Breadcrumb prefix is quite long (' . strlen($prefix) . ' chars) - consider shortening';
1290 + if (!empty($prefix) && mb_strlen($prefix) > 50) {
1291 + // mb_strlen: this number is shown to the user as "chars" (#687).
1292 + $optimization['suggestions'][] = 'Breadcrumb prefix is quite long (' . mb_strlen($prefix) . ' chars) - consider shortening';
917 1293 $optimization['score'] -= 5;
918 1294 }
919 1295
920 1296 // Current page display
@@ -1045,13 +1421,16 @@
1045 1421 }
1046 1422
1047 1423 // Additional logo analysis for local images
1048 1424 if (!empty($logo_url) && filter_var($logo_url, FILTER_VALIDATE_URL)) {
1049 - $attachment_id = attachment_url_to_postid($logo_url);
1425 + $attachment_id = Attachment_Lookup::id_from_url($logo_url);
1050 1426 if ($attachment_id) {
1051 1427 $image_meta = wp_get_attachment_metadata($attachment_id);
1052 - $width = isset($image_meta['width']) ? (int) $image_meta['width'] : 0;
1053 - $height = isset($image_meta['height']) ? (int) $image_meta['height'] : 0;
1428 + // The configured file's own size — a logo picked at a generated
1429 + // size is not as large as the upload behind it.
1430 + $logo_file = Attachment_Lookup::describe($attachment_id, $logo_url);
1431 + $width = $logo_file['width'];
1432 + $height = $logo_file['height'];
1054 1433
1055 1434 // SVG logos store 0x0 metadata — no dimension/ratio analysis
1056 1435 // is possible (and dividing by 0 is fatal).
1057 1436 if ($image_meta && $width > 0 && $height > 0) {
@@ -1154,11 +1533,12 @@
1154 1533 $optimization['score'] -= 15;
1155 1534 }
1156 1535 }
1157 1536
1158 - // Business type validation
1159 - if (empty($settings['business_type'])) {
1160 - $optimization['suggestions'][] = 'Select a specific business type for better schema markup';
1537 + // Business type validation (shared rule, one message — #622).
1538 + $business_type = $this->business_type_status($settings);
1539 + if ('suggestion' === $business_type['status']) {
1540 + $optimization['suggestions'][] = $business_type['message'];
1161 1541 $optimization['score'] -= 5;
1162 1542 }
1163 1543
1164 1544 // Email validation
@@ -1688,24 +2068,17 @@
1688 2068 'icon' => '✗'
1689 2069 ];
1690 2070 }
1691 2071
1692 - // Business Type validation
1693 - if (!empty($settings['business_type']) && $settings['business_type'] !== 'LocalBusiness') {
1694 - $field_details[] = [
1695 - 'field' => 'business_type',
1696 - 'label' => 'Business type is selected for proper schema markup.',
1697 - 'status' => 'valid',
1698 - 'icon' => '✓'
1699 - ];
1700 - } else {
1701 - $field_details[] = [
1702 - 'field' => 'business_type',
1703 - 'label' => 'Specific business type selection recommended for better schema markup.',
1704 - 'status' => 'suggestion',
1705 - 'icon' => '⚠'
1706 - ];
1707 - }
2072 + // Business Type validation — see business_type_status() for why there
2073 + // is exactly one rule here now (#622).
2074 + $business_type = $this->business_type_status($settings);
2075 + $field_details[] = [
2076 + 'field' => 'business_type',
2077 + 'label' => $business_type['message'],
2078 + 'status' => $business_type['status'],
2079 + 'icon' => 'valid' === $business_type['status'] ? '✓' : '⚠',
2080 + ];
1708 2081
1709 2082 // Address validation (NAP consistency)
1710 2083 $address_fields = ['business_address', 'business_city', 'business_state', 'business_country'];
1711 2084 $address_complete = true;
@@ -2389,11 +2762,15 @@
2389 2762 } else {
2390 2763 $validation['suggestions'][] = 'Add business hours to improve local search visibility';
2391 2764 }
2392 2765
2393 - // Validate business type
2394 - if (empty($settings['business_type'])) {
2395 - $validation['suggestions'][] = 'Select a specific business type for better schema markup';
2766 + // Business type, through the shared rule (#622). This is the only place
2767 + // it is reported on the generic path: validate_settings() with no tab
2768 + // context attaches basic-info field details, not business-info ones, so
2769 + // without this the setting would go unreported there entirely.
2770 + $business_type = $this->business_type_status($settings);
2771 + if ('suggestion' === $business_type['status']) {
2772 + $validation['suggestions'][] = $business_type['message'];
2396 2773 }
2397 2774
2398 2775 return $validation;
2399 2776 }
@@ -2485,8 +2862,47 @@
2485 2862 * @since 2.0.1
2486 2863 *
2487 2864 * @return string[]
2488 2865 */
2866 + /**
2867 + * The stored alternate name(s), shaped for schema output.
2868 + *
2869 + * schema.org and Google both allow `alternateName` to carry one value or
2870 + * several, and the store already round-trips either shape, so this accepts
2871 + * both and normalises: null when there is nothing to publish, a bare string
2872 + * for one name, a list for more. Emitting a one-element array would be
2873 + * valid but noisier than it needs to be.
2874 + *
2875 + * Shared because both WebSite producers need it and must agree — a property
2876 + * added to one and not the other is how #688 happened.
2877 + *
2878 + * @since 2.7.0
2879 + *
2880 + * @param mixed $value Stored alternate_name value.
2881 + * @return string|string[]|null
2882 + */
2883 + public static function alternate_name_for_schema($value) {
2884 + $names = [];
2885 +
2886 + foreach ((array) $value as $name) {
2887 + if (!is_scalar($name)) {
2888 + continue;
2889 + }
2890 +
2891 + $name = trim((string) $name);
2892 +
2893 + if ('' !== $name && !in_array($name, $names, true)) {
2894 + $names[] = $name;
2895 + }
2896 + }
2897 +
2898 + if (empty($names)) {
2899 + return null;
2900 + }
2901 +
2902 + return 1 === count($names) ? $names[0] : $names;
2903 + }
2904 +
2489 2905 protected function additional_setting_keys(): array {
2490 2906 return [
2491 2907 // Title formats, one per context.
2492 2908 'homepage_title', 'post_title', 'page_title', 'category_title',
@@ -2491,9 +2907,9 @@
2491 2907 // Title formats, one per context.
2492 2908 'homepage_title', 'post_title', 'page_title', 'category_title',
2493 2909 'tag_title', 'author_title', 'search_title', 'archive_title',
2494 2910 // Breadcrumbs.
2495 - 'breadcrumb_prefix', 'show_current_page',
2911 + 'breadcrumb_prefix', 'show_current_page', 'breadcrumb_use_seo_title',
2496 2912 // Identity, as written by the setup wizard and the importers.
2497 2913 'alternate_name', 'identity_type', 'represents',
2498 2914 'default_meta_description', 'default_social_image',
2499 2915 'social_media_accounts',
@@ -2500,8 +2916,10 @@
2500 2916 // Schema toggles that live on this screen.
2501 2917 'organization_schema', 'knowledge_graph',
2502 2918 // Robots rules composed by the Robots.txt panel.
2503 2919 'custom_robots_rules',
2920 + // Per-agent AI crawler allow/block map (#657).
2921 + 'ai_crawler_rules',
2504 2922 // Hero section.
2505 2923 'hero_title', 'hero_subtitle', 'hero_cta_text', 'hero_cta_url',
2506 2924 'hero_background_image',
2507 2925 // Local SEO / business details.
@@ -2513,8 +2931,118 @@
2513 2931 ];
2514 2932 }
2515 2933
2516 2934 /**
2935 + * Sanitize settings, normalising the AI crawler rule map.
2936 + *
2937 + * The generic array sanitizer keeps the shape but says nothing about the
2938 + * values: a payload could store `ai_crawler_rules[gptbot] = "maybe"`, or a
2939 + * slug no crawler answers to, and both would round-trip through every
2940 + * later response. Normalising here rather than in the REST handler puts it
2941 + * on the one path every writer shares — the settings route, the robots
2942 + * route and the MCP abilities all land in save_settings() (#657).
2943 + *
2944 + * @since 2.5.0
2945 + *
2946 + * @param array $settings Settings to sanitize.
2947 + * @param string $context_type Context type.
2948 + * @return array Sanitized settings.
2949 + */
2950 + protected function sanitize_settings(array $settings, string $context_type = 'site'): array {
2951 + $sanitized = parent::sanitize_settings($settings, $context_type);
2952 +
2953 + if (array_key_exists('ai_crawler_rules', $sanitized)) {
2954 + $sanitized['ai_crawler_rules'] = AI_Crawlers::normalize_rules($sanitized['ai_crawler_rules']);
2955 + }
2956 +
2957 + // Same reasoning one key up, for the scheme override (#638). Anything
2958 + // that is not one of the three modes means "follow WordPress", and is
2959 + // stored as that rather than kept verbatim — otherwise get-site-identity
2960 + // -settings would report a scheme the site does not actually publish.
2961 + if (array_key_exists('canonical_scheme', $sanitized)) {
2962 + $sanitized['canonical_scheme'] = in_array($sanitized['canonical_scheme'], Url_Scheme::MODES, true)
2963 + ? $sanitized['canonical_scheme']
2964 + : Url_Scheme::AUTOMATIC;
2965 + }
2966 +
2967 + // Same reasoning again for the business type. It goes straight into
2968 + // LocalBusiness schema, so a type that is not in the schema.org
2969 + // vocabulary is invalid structured data — and storing it verbatim would
2970 + // have get-site-identity-settings report a type the site cannot
2971 + // actually publish. An empty value keeps meaning "not set"; anything
2972 + // else unrecognised falls back to the general-purpose root (#623).
2973 + if (array_key_exists('business_type', $sanitized)) {
2974 + $type = (string) $sanitized['business_type'];
2975 +
2976 + if ('' !== $type && !\ThinkRank\Config\Local_Business_Types_Config::is_valid($type)) {
2977 + $type = \ThinkRank\Config\Local_Business_Types_Config::ROOT;
2978 + }
2979 +
2980 + $sanitized['business_type'] = $type;
2981 + }
2982 +
2983 + return $sanitized;
2984 + }
2985 +
2986 + /**
2987 + * schema.org's general-purpose LocalBusiness type.
2988 + *
2989 + * The default, the first option in the control, and a valid answer in its
2990 + * own right — which is the whole point of #622.
2991 + *
2992 + * @since 2.10.0
2993 + * @var string
2994 + */
2995 + private const GENERAL_BUSINESS_TYPE = 'LocalBusiness';
2996 +
2997 + /**
2998 + * The one rule for whether a business type needs the user's attention.
2999 + *
3000 + * There were three, with two wordings and two different conditions. Two
3001 + * fired when the value was empty; the third fired when it WAS
3002 + * `LocalBusiness` — which is the default, the first option in the control
3003 + * and a perfectly valid schema.org type. So the warning appeared out of the
3004 + * box for every site, could not be cleared without choosing a type that
3005 + * might be inaccurate, and on an empty value it appeared three times in two
3006 + * different phrasings, which is why it was reported as showing twice (#622).
3007 + *
3008 + * The rule now: a type is expected, and any type in the vocabulary is a
3009 + * correct answer. Only an unset value is worth prompting about.
3010 + * `LocalBusiness` is the general-purpose answer and is accepted as one —
3011 + * with a note that a more specific type sharpens the schema, phrased as the
3012 + * guidance it is rather than as a fault the user has to clear.
3013 + *
3014 + * @since 2.10.0
3015 + *
3016 + * @param array $settings Site identity settings.
3017 + * @return array{status:string,message:string} `valid` or `suggestion`.
3018 + */
3019 + private function business_type_status(array $settings): array {
3020 + $type = trim((string) ($settings['business_type'] ?? ''));
3021 +
3022 + if ('' === $type) {
3023 + return [
3024 + 'status' => 'suggestion',
3025 + 'message' => __('Select a business type so your local schema describes the right kind of business.', 'thinkrank'),
3026 + ];
3027 + }
3028 +
3029 + // The literal rather than a constant from the expanded type list (#623):
3030 + // that lands on its own branch, and this fix must not wait on it.
3031 + if (self::GENERAL_BUSINESS_TYPE === $type) {
3032 + return [
3033 + 'status' => 'valid',
3034 + 'message' => __('Business type is set to Local Business. A more specific type sharpens your schema, if one fits.', 'thinkrank'),
3035 + ];
3036 + }
3037 +
3038 + return [
3039 + 'status' => 'valid',
3040 + 'message' => __('Business type is selected for proper schema markup.', 'thinkrank'),
3041 + ];
3042 + }
3043 +
3044 + /**
2517 3045 * Get default settings for a context type (implements interface)
2518 3046 *
2519 3047 * @since 1.0.0
2520 3048 *
@@ -2534,9 +3062,32 @@
2534 3062 'breadcrumb_home_text' => 'Home',
2535 3063 'breadcrumb_separator' => '>',
2536 3064 'robots_txt_enabled' => true,
2537 3065 'allow_search_engines' => true,
3066 + // Answer 404 when a content selector in the URL resolved to
3067 + // nothing (#634). On by default, unlike the other new settings
3068 + // here: it changes no URL a visitor or a correct crawler uses, only
3069 + // ones where WordPress resolved nothing and served the blog listing
3070 + // at 200 anyway.
3071 + 'query_protection' => true,
3072 +
3073 + // Feed controls (#635). All three off, so an upgrade changes
3074 + // nothing about what an existing site already sends its
3075 + // subscribers; a brand-new install is seeded with the signature and
3076 + // the noindex on, in Activator::seed_feed_defaults().
3077 + 'feed_excerpt_only' => false,
3078 + 'feed_source_link' => false,
3079 + 'feed_noindex' => false,
3080 +
3081 + // The scheme self-referential URLs go out with (#638). 'automatic'
3082 + // means substitute nothing and follow WordPress, which is what
3083 + // every site did before the setting existed.
3084 + 'canonical_scheme' => Url_Scheme::AUTOMATIC,
2538 3085 'robots_txt_content' => '',
3086 + // Empty map = every AI crawler allowed. Defaults must stay
3087 + // permissive so an upgrade never starts blocking a crawler a site
3088 + // was happily serving (#657).
3089 + 'ai_crawler_rules' => [],
2539 3090 'logo_url' => '',
2540 3091 'favicon_url' => '',
2541 3092 'apple_touch_icon_url' => ''
2542 3093 ];
@@ -2745,16 +3296,17 @@
2745 3296 // Remove extra whitespace
2746 3297 $title = preg_replace('/\s+/', ' ', $title);
2747 3298 $title = trim($title);
2748 3299
2749 - // Ensure title is not too long (60 characters max for SEO)
2750 - if (strlen($title) > 60) {
2751 - // Try to truncate at word boundary
2752 - $title = wp_trim_words($title, 8, '...');
2753 - if (strlen($title) > 60) {
2754 - $title = substr($title, 0, 57) . '...';
2755 - }
2756 - }
3300 + // Ensure title is not too long (60 characters max for SEO).
3301 + // All three units here were wrong for non-Latin text: strlen() counts
3302 + // BYTES so the gate fired at 20 Thai characters, wp_trim_words() counts
3303 + // CHARACTERS on th/ja/zh_* so `8` cut the title to 8 of them, and
3304 + // substr() cuts bytes so it split a character mid-sequence (#687).
3305 + $title = \ThinkRank\Core\Seo_Text::trim_to_length(
3306 + $title,
3307 + \ThinkRank\Core\Seo_Text::TITLE_MAX_LENGTH
3308 + );
2757 3309
2758 3310 // Ensure title is not empty
2759 3311 if (empty($title)) {
2760 3312 $title = get_bloginfo('name');
@@ -3144,8 +3696,29 @@
3144 3696 * @since 1.0.0
3145 3697 * @return array Array of sitemap URLs
3146 3698 */
3147 3699 private function get_sitemap_urls_for_robots(): array {
3700 + // One wrapper over every return path below, including the #104 extras.
3701 + // The Sitemap: line is the only absolute URL of ours in robots.txt and
3702 + // the one a crawler follows to find everything else, so it has to carry
3703 + // the site's scheme preference (#638). Applied here rather than where
3704 + // the body is assembled, because that path also renders a robots.txt a
3705 + // site owner typed themselves, and their text is not ours to rewrite.
3706 + return array_map(
3707 + static function (string $url): string {
3708 + return Url_Scheme::apply($url);
3709 + },
3710 + $this->collect_sitemap_urls_for_robots()
3711 + );
3712 + }
3713 +
3714 + /**
3715 + * The sitemap URLs robots.txt advertises, before the scheme preference.
3716 + *
3717 + * @since 1.0.0
3718 + * @return array Array of sitemap URLs
3719 + */
3720 + private function collect_sitemap_urls_for_robots(): array {
3148 3721 try {
3149 3722 // Get sitemap settings
3150 3723 $sitemap_generator = new \ThinkRank\SEO\Sitemap_Generator();
3151 3724 $sitemap_settings = $sitemap_generator->get_settings('site');
@@ -3188,14 +3761,39 @@
3188 3761 if (empty($sitemap_urls)) {
3189 3762 $sitemap_urls[] = home_url('/sitemap.xml');
3190 3763 }
3191 3764
3192 - // No index on this install, so the local business sitemap has no
3193 - // other discovery path — advertise it directly.
3194 - if (file_exists(ABSPATH . 'local-sitemap.xml')) {
3195 - $local_url = home_url('/local-sitemap.xml');
3196 - if (!in_array($local_url, $sitemap_urls, true)) {
3197 - $sitemap_urls[] = $local_url;
3765 + // No index on this install, so anything not already listed above has
3766 + // no other discovery path — advertise it directly. The local
3767 + // business sitemap and the sitemaps other plugins register both land
3768 + // here for the same reason, so they go through one list (#104).
3769 + $extra = [];
3770 +
3771 + // Not a file test. Under dynamic delivery the local sitemap is
3772 + // served from PHP and no file is ever written, so file_exists()
3773 + // silently dropped a sitemap the site really does publish (#752).
3774 + // On static sites the file is still what proves it, so both count.
3775 + $local_sitemap_published = file_exists(ABSPATH . 'local-sitemap.xml');
3776 +
3777 + if (!$local_sitemap_published && class_exists('ThinkRank\\SEO\\Sitemap_Generator')) {
3778 + $generator = new \ThinkRank\SEO\Sitemap_Generator(false);
3779 +
3780 + $local_sitemap_published = 'dynamic' === $generator->resolve_delivery_mode()
3781 + && $generator->publishes_local_sitemap();
3782 + }
3783 +
3784 + if ($local_sitemap_published) {
3785 + $extra[] = '/local-sitemap.xml';
3786 + }
3787 +
3788 + foreach (\ThinkRank\SEO\Sitemap_Generator::additional_sitemaps() as $path) {
3789 + $extra[] = $path;
3790 + }
3791 +
3792 + foreach ($extra as $path) {
3793 + $url = home_url($path);
3794 + if (!in_array($url, $sitemap_urls, true)) {
3795 + $sitemap_urls[] = $url;
3198 3796 }
3199 3797 }
3200 3798
3201 3799 return $sitemap_urls;
@@ -3380,8 +3978,116 @@
3380 3978 return $rules;
3381 3979 }
3382 3980
3383 3981 /**
3982 + * Opening fence of the machine-owned AI crawler region.
3983 + *
3984 + * @since 2.5.0
3985 + * @var string
3986 + */
3987 + public const AI_BLOCK_BEGIN = '# BEGIN ThinkRank AI crawlers';
3988 +
3989 + /**
3990 + * Closing fence of the machine-owned AI crawler region.
3991 + *
3992 + * @since 2.5.0
3993 + * @var string
3994 + */
3995 + public const AI_BLOCK_END = '# END ThinkRank AI crawlers';
3996 +
3997 + /**
3998 + * Render the fenced AI crawler region for the current settings.
3999 + *
4000 + * One `User-agent:` / `Disallow: /` record per blocked crawler. Allowed
4001 + * crawlers emit nothing at all: `Disallow:` with an empty value is the
4002 + * robots.txt way of saying "allow everything", but writing eighteen such
4003 + * records to say what silence already says would triple the file and
4004 + * invite the reading that an unlisted crawler is therefore refused.
4005 + *
4006 + * @since 2.5.0
4007 + *
4008 + * @param array $settings Site settings.
4009 + * @return string Fenced block, newline-terminated, or '' when nothing is blocked.
4010 + */
4011 + private function build_ai_crawler_block(array $settings): string {
4012 + $blocked = AI_Crawlers::blocked_slugs($settings['ai_crawler_rules'] ?? []);
4013 +
4014 + if (empty($blocked)) {
4015 + return '';
4016 + }
4017 +
4018 + $agents = AI_Crawlers::all();
4019 +
4020 + $lines = [
4021 + self::AI_BLOCK_BEGIN,
4022 + '# Managed by ThinkRank — edits between these lines are overwritten.',
4023 + ];
4024 +
4025 + foreach ($blocked as $slug) {
4026 + $lines[] = '';
4027 + $lines[] = 'User-agent: ' . $agents[$slug]['token'];
4028 + $lines[] = 'Disallow: /';
4029 + }
4030 +
4031 + $lines[] = self::AI_BLOCK_END;
4032 +
4033 + return implode("\n", $lines) . "\n";
4034 + }
4035 +
4036 + /**
4037 + * Remove the fenced AI crawler region from a robots.txt body.
4038 + *
4039 + * Tolerates a missing closing fence rather than leaving the rest of the
4040 + * file swallowed: a truncated write, or someone deleting the END line by
4041 + * hand, would otherwise make every subsequent read drop everything below
4042 + * the opening fence.
4043 + *
4044 + * @since 2.5.0
4045 + *
4046 + * @param string $body Robots.txt body.
4047 + * @return string Body with the region removed.
4048 + */
4049 + public function strip_ai_crawler_block(string $body): string {
4050 + if (false === strpos($body, self::AI_BLOCK_BEGIN)) {
4051 + return $body;
4052 + }
4053 +
4054 + $pattern = '/\R*' . preg_quote(self::AI_BLOCK_BEGIN, '/')
4055 + . '.*?(?:' . preg_quote(self::AI_BLOCK_END, '/') . '|\z)\R*/s';
4056 +
4057 + return trim((string) preg_replace($pattern, "\n\n", $body, 1));
4058 + }
4059 +
4060 + /**
4061 + * Put the current AI crawler region into a robots.txt body.
4062 + *
4063 + * Replaces an existing region in place so the block keeps its position in
4064 + * a hand-ordered file, and appends when there is none. Everything outside
4065 + * the fences is returned untouched — that is the whole point of fencing
4066 + * it, since the body is also a free-text field the user edits.
4067 + *
4068 + * @since 2.5.0
4069 + *
4070 + * @param string $body Robots.txt body (fences optional).
4071 + * @param array $settings Site settings.
4072 + * @return string Body carrying the current region.
4073 + */
4074 + private function apply_ai_crawler_block(string $body, array $settings): string {
4075 + $stripped = $this->strip_ai_crawler_block($body);
4076 + $block = $this->build_ai_crawler_block($settings);
4077 +
4078 + if ('' === $block) {
4079 + return $stripped;
4080 + }
4081 +
4082 + if ('' === trim($stripped)) {
4083 + return trim($block);
4084 + }
4085 +
4086 + return rtrim($stripped) . "\n\n" . trim($block);
4087 + }
4088 +
4089 + /**
3384 4090 * The auto-generated header prepended to the served robots.txt.
3385 4091 *
3386 4092 * Kept separate from the body so it is only ever added at render time with
3387 4093 * a fresh timestamp, never stored or shown in the editable textarea.
@@ -3418,11 +4124,16 @@
3418 4124 */
3419 4125 public function get_served_robots_body(): string {
3420 4126 $settings = $this->get_settings('site');
3421 4127
4128 + // The AI block is stripped from every one of these paths. A physical
4129 + // robots.txt we wrote carries it, and the stored override is whatever
4130 + // the textarea last held — so without this the block round-trips into
4131 + // the editor, gets saved as ordinary body text, and is then appended
4132 + // to a second time on the next render.
3422 4133 $custom = trim((string) ($settings['robots_txt_content'] ?? ''));
3423 4134 if ($custom !== '') {
3424 - return $this->strip_robots_header($custom);
4135 + return $this->strip_ai_crawler_block($this->strip_robots_header($custom));
3425 4136 }
3426 4137
3427 4138 $robots_file = ABSPATH . 'robots.txt';
3428 4139 if (file_exists($robots_file)) {
@@ -3428,13 +4139,13 @@
3428 4139 if (file_exists($robots_file)) {
3429 4140 // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents, WordPress.PHP.NoSilencedErrors.Discouraged -- an unreadable robots.txt is an expected state answered with an empty string.
3430 4141 $raw = (string) @file_get_contents($robots_file);
3431 4142 if ($raw !== '') {
3432 - return $this->strip_robots_header($raw);
4143 + return $this->strip_ai_crawler_block($this->strip_robots_header($raw));
3433 4144 }
3434 4145 }
3435 4146
3436 - return trim($this->generate_robots_txt()['content']);
4147 + return $this->strip_ai_crawler_block(trim($this->generate_robots_txt()['content']));
3437 4148 }
3438 4149 private function get_site_identity_data(array $settings): array {
3439 4150 return [
3440 4151 'site_name' => $settings['site_name'] ?? get_bloginfo('name'),
@@ -3496,11 +4207,14 @@
3496 4207 $optimization['validation']['valid'] = false;
3497 4208 }
3498 4209
3499 4210 if (!empty($value) && isset($config['max_length'])) {
3500 - if (strlen($value) > $config['max_length']) {
4211 + // The warning says "characters", so measure and cut in characters:
4212 + // strlen()/substr() fired early on non-Latin values and the
4213 + // suggested replacement was cut mid-character (#687).
4214 + if (mb_strlen($value) > $config['max_length']) {
3501 4215 $optimization['validation']['warnings'][] = "{$element} exceeds maximum length of {$config['max_length']} characters";
3502 - $optimization['optimized_value'] = substr($value, 0, $config['max_length']);
4216 + $optimization['optimized_value'] = \ThinkRank\Core\Seo_Text::trim_to_length($value, (int) $config['max_length']);
3503 4217 }
3504 4218 }
3505 4219
3506 4220 // SEO-specific optimizations
@@ -3539,18 +4253,20 @@
3539 4253 return $optimization;
3540 4254 }
3541 4255
3542 4256 // Check if it's a local image
3543 - $attachment_id = attachment_url_to_postid($value);
4257 + $attachment_id = Attachment_Lookup::id_from_url($value);
3544 4258 if ($attachment_id) {
3545 4259 $image_meta = wp_get_attachment_metadata($attachment_id);
3546 4260
3547 4261 if ($image_meta && isset($image_meta['width'], $image_meta['height'])) {
3548 - // Check recommended size
4262 + // Check recommended size, against the configured file itself
4263 + // rather than the upload it may have been generated from.
3549 4264 if (isset($config['recommended_size'])) {
3550 4265 [$rec_width, $rec_height] = explode('x', $config['recommended_size']);
4266 + $image_file = Attachment_Lookup::describe($attachment_id, $value);
3551 4267
3552 - if ((int) $image_meta['width'] !== (int) $rec_width || (int) $image_meta['height'] !== (int) $rec_height) {
4268 + if ($image_file['width'] !== (int) $rec_width || $image_file['height'] !== (int) $rec_height) {
3553 4269 $optimization['suggestions'][] = "Consider using {$config['recommended_size']} size for optimal {$element}";
3554 4270 }
3555 4271 }
3556 4272