# thinkrank/2.7.0/includes/abilities/settings/class-settings-key-map.php ThinkRank AI SEO – AI SEO Plugin for WordPress: Schema, XML Sitemaps, Meta Tags, Search Console & Local SEO, version 2.7.0. 460 lines. - Page: https://pluginprobe.com/plugins/thinkrank/2.7.0/code/includes/abilities/settings/class-settings-key-map.php - Raw: https://pluginprobe.com/plugins/thinkrank/2.7.0/raw/includes/abilities/settings/class-settings-key-map.php - Modified: 2026-09-17T09:21:20+00:00 Line numbers below start at 1. Link to a line or a range by appending a fragment to the page URL, for example `https://pluginprobe.com/plugins/thinkrank/2.7.0/code/includes/abilities/settings/class-settings-key-map.php#L10-L20`. ```php Key => the ability that owns it. */ public const SITE_IDENTITY_ELSEWHERE = [ 'robots_txt_content' => 'thinkrank/update-robots-txt', 'custom_robots_rules' => 'thinkrank/update-robots-txt', 'knowledge_graph' => 'thinkrank/update-schema-settings', 'organization_schema' => 'thinkrank/update-schema-settings', 'post_title' => 'thinkrank/update-global-settings', 'page_title' => 'thinkrank/update-global-settings', ]; /** * `sitemap` keys that are derived state rather than settings. * * @var array Key => why it is not exposed. */ public const SITEMAP_ELSEWHERE = [ 'last_generated' => 'written by the generator, not a setting', 'sitemap_urls' => 'written by the generator, not a setting', 'selected_preset' => 'UI marker the settings screen maintains for itself', ]; /** * JSON schema properties for every exposed `site_identity` key. * * @return array> */ public static function site_identity(): array { return [ // Core. 'enabled' => self::boolean( __( 'Whether site identity management is active.', 'thinkrank' ) ), 'site_name' => self::string( __( 'Official name of the site, used in titles and schema.', 'thinkrank' ) ), 'site_description' => self::string( __( 'Short description of the site.', 'thinkrank' ) ), 'tagline' => self::string( __( 'Site tagline.', 'thinkrank' ) ), 'alternate_name' => self::alternate_name(), 'identity_type' => self::string( __( 'What the site is, e.g. "blog", "business", "portfolio".', 'thinkrank' ) ), 'represents' => self::string( __( 'Whether the site represents a "person" or an "organization".', 'thinkrank' ) ), 'default_meta_description' => self::string( __( 'Meta description used where no more specific one is set.', 'thinkrank' ) ), 'default_social_image' => self::string( __( 'URL of the fallback social sharing image.', 'thinkrank' ) ), 'social_media_accounts' => [ 'type' => 'array', 'description' => __( 'Profile URLs for the site\'s social accounts.', 'thinkrank' ), 'items' => [ 'type' => 'string' ], ], // Titles. These are %token% templates; the manager sanitizes them // without stripping their tokens. 'title_template' => self::string( __( 'Named title layout, e.g. "default", "reverse", "category".', 'thinkrank' ) ), 'title_separator' => self::string( __( 'Separator between title parts, e.g. "pipe", "dash".', 'thinkrank' ) ), 'homepage_title' => self::template( __( 'the homepage', 'thinkrank' ), '' ), 'category_title' => self::template( __( 'category archives', 'thinkrank' ), '%category_title%, %category%' ), 'tag_title' => self::template( __( 'tag archives', 'thinkrank' ), '%tag_title%' ), 'author_title' => self::template( __( 'author archives', 'thinkrank' ), '%author_name%' ), 'search_title' => self::template( __( 'search results pages', 'thinkrank' ), '%search_term%' ), 'archive_title' => self::template( __( 'date and other archives', 'thinkrank' ), '%archive_title%' ), // Breadcrumbs. 'breadcrumbs_enabled' => self::boolean( __( 'Whether breadcrumb markup is generated.', 'thinkrank' ) ), 'breadcrumb_type' => self::string( __( 'Breadcrumb structure, e.g. "hierarchical".', 'thinkrank' ) ), 'breadcrumb_home_text' => self::string( __( 'Label for the home link in breadcrumbs.', 'thinkrank' ) ), 'breadcrumb_separator' => self::string( __( 'Separator drawn between breadcrumb items.', 'thinkrank' ) ), 'breadcrumb_prefix' => self::string( __( 'Text shown before the breadcrumb trail.', 'thinkrank' ) ), 'show_current_page' => self::boolean( __( 'Whether the current page appears in its own breadcrumb trail.', 'thinkrank' ) ), 'breadcrumb_use_seo_title' => self::boolean( __( 'Whether breadcrumb labels use the SEO title of a post or term when one is set, instead of its raw title.', 'thinkrank' ) ), // Brand imagery. 'logo_url' => self::string( __( 'URL of the site logo.', 'thinkrank' ) ), 'favicon_url' => self::string( __( 'URL of the site favicon.', 'thinkrank' ) ), 'apple_touch_icon_url' => self::string( __( 'URL of the Apple touch icon.', 'thinkrank' ) ), // Homepage hero. 'hero_title' => self::string( __( 'Homepage hero heading.', 'thinkrank' ) ), 'hero_subtitle' => self::string( __( 'Homepage hero subheading.', 'thinkrank' ) ), 'hero_cta_text' => self::string( __( 'Label on the homepage hero call to action.', 'thinkrank' ) ), 'hero_cta_url' => self::string( __( 'URL the homepage hero call to action points at.', 'thinkrank' ) ), 'hero_background_image' => self::string( __( 'URL of the homepage hero background image.', 'thinkrank' ) ), // Business / Local SEO. Feeds LocalBusiness schema. 'local_seo_enabled' => self::boolean( __( 'Whether Local SEO output and LocalBusiness schema are enabled.', 'thinkrank' ) ), 'business_name' => self::string( __( 'Registered business name.', 'thinkrank' ) ), 'business_type' => self::string( __( 'schema.org business type, e.g. "Restaurant", "Store".', 'thinkrank' ) ), 'business_email' => self::string( __( 'Public contact email address.', 'thinkrank' ) ), 'business_phone' => self::string( __( 'Public contact telephone number.', 'thinkrank' ) ), 'business_address' => self::string( __( 'Street address.', 'thinkrank' ) ), 'business_city' => self::string( __( 'City or locality.', 'thinkrank' ) ), 'business_state' => self::string( __( 'State, province or region.', 'thinkrank' ) ), 'business_country' => self::string( __( 'Country.', 'thinkrank' ) ), 'business_postal_code' => self::string( __( 'Postal or ZIP code.', 'thinkrank' ) ), 'business_latitude' => self::string( __( 'Latitude of the business location, in decimal degrees.', 'thinkrank' ) ), 'business_longitude' => self::string( __( 'Longitude of the business location, in decimal degrees.', 'thinkrank' ) ), 'business_price_range' => self::string( __( 'Price range indicator, e.g. "$$".', 'thinkrank' ) ), 'business_hours' => self::business_hours(), // Indexing. 'allow_search_engines' => self::boolean( __( 'Whether search engines are allowed to index the site.', 'thinkrank' ) ), 'query_protection' => self::boolean( __( 'Whether a URL whose content selector resolved to nothing (for example ?post_type=nosuchtype) answers 404 instead of serving the blog listing at 200.', 'thinkrank' ) ), 'canonical_scheme' => [ 'type' => 'string', 'description' => __( 'Scheme for canonical URLs, og:url, schema @ids and sitemap entries. "automatic" follows WordPress; the other two override it, for a site behind a proxy that terminates TLS and leaves WordPress reporting the wrong scheme.', 'thinkrank' ), 'enum' => \ThinkRank\SEO\Url_Scheme::MODES, ], 'robots_txt_enabled' => self::boolean( __( 'Whether ThinkRank manages robots.txt. Its contents are set with thinkrank/update-robots-txt.', 'thinkrank' ) ), // RSS feeds. 'feed_excerpt_only' => self::boolean( __( 'Whether feed entries are shortened to an excerpt instead of carrying the full post.', 'thinkrank' ) ), 'feed_source_link' => self::boolean( __( 'Whether each feed entry is signed with a link back to the original post and the site.', 'thinkrank' ) ), 'feed_noindex' => self::boolean( __( 'Whether feeds are served with X-Robots-Tag: noindex. Leave off for a podcast feed, which needs to be indexable.', 'thinkrank' ) ), 'ai_crawler_rules' => self::ai_crawler_rules(), ]; } /** * JSON schema properties for every exposed `sitemap` key. * * @return array> */ public static function sitemap(): array { return [ 'enabled' => self::boolean( __( 'Whether XML sitemap generation is active.', 'thinkrank' ) ), 'auto_generate' => self::boolean( __( 'Whether the sitemap regenerates automatically when content changes.', 'thinkrank' ) ), 'use_sitemap_index' => self::boolean( __( 'Whether to publish a sitemap index that links per-type sitemaps, rather than one flat file.', 'thinkrank' ) ), 'links_per_sitemap' => [ 'type' => 'integer', 'description' => __( 'Maximum URLs per sitemap file before it is split.', 'thinkrank' ), 'minimum' => 1, 'maximum' => 50000, ], 'custom_url_pattern' => self::string( __( 'Filename pattern for generated sitemaps, e.g. "sitemap-{type}.xml".', 'thinkrank' ) ), 'enable_styling' => self::boolean( __( 'Whether an XSL stylesheet is attached so the sitemap is readable in a browser.', 'thinkrank' ) ), 'ping_search_engines' => self::boolean( __( 'Whether search engines are notified after the sitemap is regenerated.', 'thinkrank' ) ), // How the styled sitemap looks. All four need enable_styling on. 'styling_logo' => self::boolean( __( 'Whether a logo is shown above the sitemap heading. Requires enable_styling.', 'thinkrank' ) ), 'styling_logo_url' => self::string( __( 'URL of the sitemap logo image. Empty falls back to the site icon.', 'thinkrank' ) ), 'styling_color_main' => self::string( __( 'Hex colour ("#rrggbb") for the sitemap header, links and table head. Empty keeps the stock palette.', 'thinkrank' ) ), 'styling_color_accent' => self::string( __( 'Hex colour ("#rrggbb") for the header gradient end and link hovers. Empty keeps the stock palette.', 'thinkrank' ) ), // What goes in. 'include_posts' => self::boolean( __( 'Whether posts are included.', 'thinkrank' ) ), 'include_pages' => self::boolean( __( 'Whether pages are included.', 'thinkrank' ) ), 'include_categories' => self::boolean( __( 'Whether category archives are included.', 'thinkrank' ) ), 'include_tags' => self::boolean( __( 'Whether tag archives are included.', 'thinkrank' ) ), 'include_images' => self::boolean( __( 'Whether image entries are included for each URL.', 'thinkrank' ) ), 'include_featured_images' => self::boolean( __( 'Whether featured images are included as image entries.', 'thinkrank' ) ), // What stays out. 'exclude_posts' => self::string( __( 'Comma-separated post IDs to leave out.', 'thinkrank' ) ), 'exclude_terms' => self::string( __( 'Comma-separated term IDs to leave out.', 'thinkrank' ) ), 'exclude_private_posts' => self::boolean( __( 'Whether privately published posts are left out.', 'thinkrank' ) ), 'exclude_password_protected' => self::boolean( __( 'Whether password-protected posts are left out.', 'thinkrank' ) ), ]; } /** * Read the exposed keys out of a manager's stored settings. * * The store keeps everything as strings ("1"/""), so each value is coerced * back to the type the schema advertises before it reaches an agent. * * @param array> $properties Schema properties for the category. * @param array $stored Settings as the manager returns them. * @return array Exposed settings, one entry per declared key. */ public static function read( array $properties, array $stored ): array { $out = []; foreach ( $properties as $key => $property ) { $value = $stored[ $key ] ?? null; $type = $property['type'] ?? 'string'; // A union type ('string' or a list of them) keeps whichever shape // it arrived in: casting to string would flatten a list, and // casting to array would replace a name with [] (#692). if ( is_array( $type ) ) { $out[ $key ] = is_array( $value ) ? array_values( array_map( 'strval', $value ) ) : (string) ( $value ?? '' ); continue; } switch ( $type ) { case 'boolean': $out[ $key ] = (bool) $value; break; case 'integer': $out[ $key ] = (int) $value; break; case 'array': case 'object': $out[ $key ] = is_array( $value ) ? $value : []; break; default: $out[ $key ] = (string) ( $value ?? '' ); } } return $out; } /** * Coerce an incoming patch to the declared types, dropping unknown keys. * * Strings are passed through rather than sanitized here: the manager's own * save path already picks the right sanitizer per key, and running * sanitize_text_field() first would strip %date% and %category% out of the * title templates as percent-encoding before it ever got the chance (#521). * * @param array> $properties Schema properties for the category. * @param array $incoming Caller-supplied settings. * @return array Recognized keys only, coerced to type. */ public static function coerce( array $properties, array $incoming ): array { $out = []; foreach ( $properties as $key => $property ) { if ( ! array_key_exists( $key, $incoming ) ) { continue; } $value = $incoming[ $key ]; $type = $property['type'] ?? 'string'; // A union type ('string' or a list of them) keeps whichever shape // it arrived in: casting to string would flatten a list, and // casting to array would replace a name with [] (#692). if ( is_array( $type ) ) { $out[ $key ] = is_array( $value ) ? array_values( array_map( 'strval', $value ) ) : (string) ( $value ?? '' ); continue; } switch ( $type ) { case 'boolean': $out[ $key ] = (bool) $value; break; case 'integer': $number = (int) $value; if ( isset( $property['minimum'] ) ) { $number = max( (int) $property['minimum'], $number ); } if ( isset( $property['maximum'] ) ) { $number = min( (int) $property['maximum'], $number ); } $out[ $key ] = $number; break; case 'array': case 'object': if ( ! is_array( $value ) ) { // A structured key given a scalar is a caller error, not // something to flatten into a string and store. continue 2; } $out[ $key ] = $value; break; default: if ( is_array( $value ) ) { continue 2; } $out[ $key ] = (string) $value; } } return $out; } /** * The opening hours object, one entry per day. * * A real sub-schema rather than string coercion: the value is a map of day * name to {open, close, closed}, and flattening it to a string would make * it unwritable over MCP. * * @return array */ private static function business_hours(): array { $day = [ 'type' => 'object', 'additionalProperties' => false, 'properties' => [ 'open' => [ 'type' => 'string', 'description' => __( 'Opening time as 24-hour HH:MM, or "" when closed.', 'thinkrank' ), ], 'close' => [ 'type' => 'string', 'description' => __( 'Closing time as 24-hour HH:MM, or "" when closed.', 'thinkrank' ), ], 'closed' => [ 'type' => 'boolean', 'description' => __( 'Whether the business is closed all day.', 'thinkrank' ), ], ], ]; $properties = []; foreach ( [ 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday' ] as $name ) { $properties[ $name ] = $day; } return [ 'type' => 'object', 'description' => __( 'Opening hours per day of the week.', 'thinkrank' ), 'additionalProperties' => false, 'properties' => $properties, ]; } /** * The per-agent AI crawler allow/block map. * * Enumerating the known slugs rather than accepting a free-form object is * what makes this usable by an agent: the alternative is a caller guessing * `chatgpt` for a crawler registered as `chatgpt-user`, having the key * dropped as unknown, and being told the save succeeded — because it did, * with nothing in it. * * @return array */ private static function ai_crawler_rules(): array { $properties = []; foreach ( \ThinkRank\SEO\AI_Crawlers::for_display() as $agent ) { $properties[ $agent['slug'] ] = [ 'type' => 'string', 'enum' => [ 'allow', 'block' ], /* translators: 1: crawler user-agent token, e.g. GPTBot. 2: what that crawler is for. */ 'description' => sprintf( __( '%1$s — %2$s', 'thinkrank' ), $agent['token'], $agent['purpose'] ), ]; } return [ 'type' => 'object', 'description' => __( 'Per-agent AI crawler rules. "block" writes a User-agent/Disallow pair for that crawler into robots.txt; "allow" (the default for any crawler not listed) writes nothing. Blocking Google-Extended does not affect normal Google Search indexing.', 'thinkrank' ), 'additionalProperties' => false, 'properties' => $properties, ]; } /** * A boolean property. * * @param string $description Translated text describing what the toggle does. * @return array */ /** * The site's alternate name, as one value or several. * * schema.org and Google both allow `alternateName` to carry a list, and the * store already round-trips either shape, so the schema says so rather than * forcing a caller to pick one name and drop the rest (#692). * * @since 2.7.0 * @return array */ private static function alternate_name(): array { return [ // A union rather than anyOf: read() and coerce() switch on `type`, // and an entry without one is dropped as unrecognised. WordPress's // schema validator accepts a type list, so this is both valid JSON // Schema and legible to this file's own consumers. 'type' => [ 'string', 'array' ], 'items' => [ 'type' => 'string' ], 'description' => __( 'Alternate or former name of the site, published as schema alternateName on the homepage WebSite node. Send a string for one name, or an array for several. Blank entries and duplicates are dropped, and a single surviving name is published as a string.', 'thinkrank' ), ]; } private static function boolean( string $description ): array { return [ 'type' => 'boolean', 'description' => $description, ]; } /** * A string property. * * @param string $description Translated text describing the value. * @return array */ private static function string( string $description ): array { return [ 'type' => 'string', 'description' => $description, ]; } /** * A %token% title template property. * * The vocabulary here is Site Identity's, which is not the one the Global * SEO per-post-type templates use — %site_title% rather than %title%, * %site_name% rather than %sitename% — so the description spells it out * instead of leaving an agent to guess between the two. * * @param string $what Translated name of the pages the template titles. * @param string $extra Comma-separated tags available only on those pages, or ''. * @return array */ private static function template( string $what, string $extra ): array { $shared = '%site_title%, %site_name%, %site_description%, %tagline%, %sep%, %separator%, %date%'; $description = '' === $extra /* translators: 1: the pages a title template applies to. 2: the list of available variable tags. */ ? sprintf( __( 'Title template for %1$s. Available tags: %2$s.', 'thinkrank' ), $what, $shared ) /* translators: 1: the pages a title template applies to. 2: tags available everywhere. 3: tags available only on those pages. */ : sprintf( __( 'Title template for %1$s. Available tags: %2$s, and on these pages also %3$s.', 'thinkrank' ), $what, $shared, $extra ); return [ 'type' => 'string', 'description' => $description, ]; } } ```