SEOmatic

Added

• Ensure that getTransformByHandle() is passed a string

Added

• Fix regression of getAssetTransforms() -> getImageTransforms()

Added

• Added the ability to choose the Asset Transform to apply to images in the sitemap (#1407)

Fixed

• Fixed a regression in extractTextFromField that could cause it to not render properly by being more explicit, looking only for arrays or Collections in isArrayLike() (#1441)
• Fixed an issue where the typeId coming in from editing the Content SEO settings was a string, when it needed to be cast to an integer (#1442) (#1368)
• Fixed an issue where the Copy Settings From menu didn't work correctly for multiple entry types (#1368)

Fixed

• Addressed an issue where if SEOmatic was set to extract text or keywords from a relation field that was eager loaded, it would extract the serialized value of the field instead of the actual text (#1415)

Fixed

• Fixed a regression that would throw an exception when attempting to save the security.txt template (#1435)

Changed

• Add PerplexityBot to the default disallow list in robots.txt, as there's no benefit to allowing it to index your site
• Allow locales to be in the format language[_territory] such that the territory is optional
• Ensure that security.txt templates always end with a new line (#1429)

Fixed

• Fixed an issue where a trailing slash would be added to a paginated URL that uses URL parameters and addTrailingSlashesToUrls was true in the General config (#1401)
• Fixed an issue where clicking the SEOmatic CP nav item would result in a 403 exception if the current user didn't have permission to view the SEOmatic dashboard (#1410)
• Fixed an issue where an exception could be thrown when generating a sitemap with assets, and the field mapping was empty (#1425)
• Fixed an issue where the @id in the mainEntityOfPage JSON-LD wouldn't be correct if the identity and creator were not the same (#1431)

Fixed

• Fixed an issue where an exception could be thrown due to a bad commit

Added

• Added the ability to generate a News Sitemap for any Section
• Added an SEOmatic Debug Toolbar Panel setting to Plugin Settings → Advanced that lets you control whether the SEOmatic Debug Toolbar panel is added to the Yii2 Debug Toolbar (if it is enabled)
• Updated to schema.org v26.0, fixes (#1420)

Changed

• Completely revamped the documentation to hopefully make it more accessible & useful (thanks to Matt Stein @ Adjacent)
• PHPstan code cleanup

Fixed

• Fixed an issue that would cause assets in Neo blocks to not appear as images in the sitemap
• Fixed an issue that would cause assets in SuperTable blocks to not appear as images in the sitemap
• Fixed an issue with missing classes in Sitemap helper
• Fixed an issue that would cause text in Neo blocks to not get extracted

Fixed

• Fixed a regression where the robots tag would be set to none for CP requests, which is incorrect, because GraphQL and meta container endpoints are CP requests (#1414)

Added

• Add phpstan and ecs code linting
• Add code-analysis.yaml GitHub action

Changed

• PHPstan code cleanup
• ECS code cleanup

Fixed

• Fixed an issue where DynamicMeta didn't properly take into account that robots can be a comma delimited list of values now (#1399)
• Fixed an issue where a robots setting of none or noindex in the Content SEO settings make it impossible to override the robots setting in an SEO Settings field (#1399)
• Added the unused static to the Tailwind CSS blocklist to avoid a name collision with a Craft CSS class (#1412)
• Added webp and gif as allowed social media image formats now that the social media sites accept them, and guard against no transform existing (#1411)

Changed

• Updated docs to use node 20 & a new sitemap plugin

Fixed

• Fixed overly large debug toolbar pane response size due to repeating inline SVG icons
• Ensure that CP requests and Tokenized requests have robots tag & header set to none (#1394)

Added

• Added a EVENT_INCLUDE_SITEMAP_ENTRY event to allow plugins or modules to determine whether entries should be added to the sitemap or not (#1393)
• Allow the config/seomatic.php siteUrlOverride to be set to either a string, or an array of site URLs, indexed by the site handle for overriding complex headless multi-site Craft setups (#1376)

Changed

• Switch over to listening for element changes via Element::EVENT_AFTER_PROPAGATE events instead of Elements::EVENT_AFTER_SAVE_ELEMENT and have it check the Element::$resaving attribute instead of Model::$scenario = SCENARIO_ESSENTIALS to determine whether sitemap queue jobs should be created (#1388)
• If the Site URL Override feature is used, pass along the parameters, too, when building the URL (#950)
• Removed the automatic Google Sitemap ping endpoint, since Google has deprecated it and will be removing it entirely soon (#1392)

Added

• Switch over to Vite ^5.0.0 & Node ^20.0.0 for the buildchain
• The sitemaps now check enabledForSite to determine whether elements should be included in the sitemap (#1388)

Changed

• Remove vestigial queue option from the console command
• Rebrand Twitter to X (Twitter) in all user-displayed text
• Updated the X (Twitter) large image previews to reflect the new style in X (Twitter)

Fixed

• Fixed an issue where the Truncate Description Tags toggle did not work as expected (#1386)
• Fixed an issue where the frontend SEO preview URLs could be wrong if you're using the Site URL Override feature (#950)

Fixed

• Only try the getMatchedElement() optimization when it's not a console request, and surround it with try/catch to catch any potentially thrown exceptions (#1384)

Changed

• Try to use Craft's matched element from UrlManager in MetaContainers if looking for an enabled element, the current siteId is being used and the current uri matches what was in the request (#1381)

Fixed

• Fixed an issue where the CanonicalLink would render if the Robots tag contained multiple values (#1378)
• Fixed incorrect references to SeoEntry in the Campaign SeoElement (#1382)

Added

• Added an SEOmatic debug panel to the Yii2 Debug Toolbar to aid in debugging SEO metadata

Added

• Added support for the Shopify plugin, so imported Shopify Products are automatically recognized by SEOmatic, and get properly mapped metadata
• Add integration with the Campaign plugin, so Campaign landing pages are automatically recognized by SEOmatic, and get properly mapped metadata
• Disallow Google Bard and Vertex AI bots in robots.txt by default, as there's no benefit to allowing it to index your site. ref: https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers#common-crawlers

Changed

• Moved the security.txt location to .well-known/security.txt from the server root, and make the bundle updating mechanism preserve user settings in the process (#1353)
• Hide the SEO Image / OG Image / Twitter Image mode selectors if transforming is disabled
• Set the twitterImageTransform and ogImageTransform to false by default, since the default is also sameAsSeo and this will result in better default expected behavior (#1364)

Fixed

• Fixed a syntax error in the digitalproductmeta JsonLD Container (#1361)

Added

• Disallow ChatGPT bot in robots.txt by default, as there's no benefit to allowing it to index your site. ref: https://www.searchenginejournal.com/openai-launches-gptbot-how-to-restrict-access/493394/

Changed

• The Plugin Settings -> Tags -> Add hreflang Tags setting now also controls whether hreflang URLs are added to sitemaps (#1340)

Fixed

• Fixed an issue that caused you to be unable to dynamically include/exclude scripts that have body JavaScript via Twig, by unifying the rendering method (#1334)
• Fixed an issue that caused the default Content SEO Site Name Position to not default to Same As Global Site Name Position (#1321) (#1333)

Fixed

• Fixed a regression caused by (#1334) which caused Google Tag Manager noscript template is output with <script> tags around it (#1346)

Changed

• Use any custom field labels for "pull fields" in SEOmatic settings (#1335)

Fixed

• Fixed an issue where the MetaJsonLd container was not properly cached, which caused a performance issue as well as storing more data in the cache than necessary
• Fixed a regression that caused the SEO Preview to not appear in the sidebar for Commerce 4, due to Commerce 4 not supporting the EVENT_DEFINE_SIDEBAR_HTML event (despite there being code in Commerce 4 that appears to support it) (#1336)
• Fixed an issue that caused you to be unable to dynamically include/exclude scripts that have body JavaScript via Twig, by unifying the rendering method (#1334)

Fixed

• Fixed an issue that would cause settings in the Tracking Scripts settings to be wiped out whenever other settings in SEOmatic were saved (#1327)

Changed

• Bumped the schema version to side-step a Craft bug that would throw an error when running craft/update with a plugin that had a new migration without a schema version change

Added

• Show a deprecation notice on the Google Analytics tracking script setting, with an explanation of it being discontinued
• Added the ability to completely disable scripts from displaying & rendering if they have been discontinued
• Add an announcement if the site is using the soon to be deprecated Google Universal Analytics via SEOmatic

Changed

• Don't try to submit sitemap indexes to search engines if sitemaps are disabled for that section

Security

• Addressed a potential XSS vulnerability when using seomatic.helper.paginate()

Changed

• Have the Site Name Position default to "Same as Global Setting" (#1321)

Fixed

• Revert (this commit) which caused CLI-based GraphQL generation to fail
• Removed vestigial "No Twitter handle has been set" message (#1316)
• Fixed an issue that would cause SEOmatic to ignore the Override lightswitch setting for SEO Settings fields in the context of generated sitemaps

Added

• Added a View Sitemap Index button to SEOmatic → Site Settings → Sitemap (#1085)

Fixed

• Fixed an issue where SEOmatic would cause other plugins to fail to be able to register Twig extensions after it when using the CLI command craft plugin/install --all (#1312)
• Fix cache-busting param on seo images (#1310)
• Fixed an issue where encodeUrlQueryParams wouldn't include the URL's port

Changed

• Ensure that makes sure that alternate site url's also take into account a potential site override url in sitemaps (#1298)
• Use the getSalePrice() for the default Product and DigitalProduct JSON-LD structured data (#930)

Changed

• Removed the requirement that the Site Twitter Handle is set for Twitter cards to be generated (#1275)

Fixed

• Fixed a caching issue that would cause the Main Entity of Page schema type menu to malfunction (#1303)

Added

• Added (Google rich result) in the Main Entity of Page dropdown, for Schema.org types that Google uses for Rich Results
• Add descriptions & links for (pending) and (Google rich result) schemas in the Main Entity of Page dropdown
• Added a caching layer to the Schema helper

Added

• Added support for Doxster field types as pull sources (#1279)
• Added Sitemap Frequency and Priority to Content SEO overview ([#1294]https://github.com/nystudio107/craft-seomatic/issues/1294)

Changed

• Don't disable hreflang tags based on whether the section is included in the sitemap or not (#1285)
• Ensure that the state of the General tab and the override switch is taken into account when determining if robots is disabled in an SEO Settings field for hreflang URLs
• Changed the sitemap submission timeout to be 5 seconds, to avoid lengthy delays if Google cannot be reached for some reason (#1288)
• Add versioning to the docs
• Add Pending types from Schema.org back into the Main Entity of Page dropdown, but mark them as (pending)

Fixed

• Fixed an issue where an error would be logged if a source Asset field was selected as an SEO Image, and it was eager loaded (#1291)
• Ensure that URL query parameters are properly encoded after being sanitized (#1075)

Added

• Updated to schema.org v15.0, fixes (#1277)

Changed

• Use dynamic docker container name & port for the buildchain
• Update the buildchain to use Vite ^4.0.0
• Refactored the docs buildchain to use a dynamic docker container setup

Fixed

• Fixed an issue where sitemaps would be regenerated even if URLs were disabled for a particular section, in certain circumstances (#1212)
• Removed the check for the now-deprecated layer property in the tree.jsonld schema from schema.org, so that it can be parsed properly

Fix

• Fixed a regression that would cause entry. to not resolve in meta values

Fix

• Fixed an issue where meta tags would not render on a very specific version of PHP (8.1.13) (#1257)

Changed

• Update to use Vite ^4.0.0 for the buildchain

Fixed

• Solspace calendar integration error would throw an exception if you deleted a Calendar (#1259)

Fixed

• Ensure that parsedValue() always returns a string

Changed

• Fixed the disabled state of SEO Settings Override fields so they look consistent
• Remove the odd Craft modifiedAttributes styling when a field value is changed (#12403)
• Removed the field class from the SEO Settings field wrapper so an additional status-badge isn't injected by Craft
• Fix the styling of the SEO Image, Twitter Image, and FaceBook OpenGraph image in the SEO Settings field when they are not overridden

Fixed

• Fixed a regression in the SEO Settings field where the Override state for a field would not save (#1239)

Changed

• Better styling for the Robots focus ring
• Refactored the docs to use the latest version of VitePress (^1.0.0-alpha.29)

Fixed

• Fixed a regression that caused entries with SEO Settings fields in them to think the entry had changed, when it hadn't (#1239)
• Fixed an issue where the Facebook Opengraph Image Transform Mode would appear in an SEO Settings field, even if it was disabled (#1240)
• Fixed an issue where extractTextFromField() would throw an exception for Neo fields (#1242)

Added

• Greatly improved the Robots field, allowing you to pick multiple values, and additional values added by Google (#1237)

Changed

• Switch from Webpack to Vite for the plugin asset build system

Fixed

• Fix query level structureDepth 'Invalid numeric value: 1<=' (#1238)

Changed

• Fixed an exception that could be thrown if you are using an SEO Settings field, by adding an explicit cast to (array) for checkbox field values that should be saved as an empty array [] but instead are saved as an empty string ''. Believed to be a regression in Craft 4.3 (#1233) (#1231)
• Handle the case where an asset's dateModified is null (#1234)

Changed

• Switch from Twigfield to Code Editor

Fixed

• Fixed an issue with Twigfield was errantly loaded in SEO Settings fields (#1229)
• Fixed an issue where Include Images & Videos in Sitemap appeared in the SEO Settings field, despite being disabled in the field settings (#1163)

Fixed

• Fix phpcs coding style CI tests

Changed

• Refactored TrackingVarsAutocomplete to use Twigfield ^1.0.12's ability to pass down data via twigfieldOptions rather than relying on the data cache

Changed

• Use App::env() to check environment (#1210)
• Added CRAFT_ENVIRONMENT check to SeomaticVariable (#1210)
• Don't bother invalidating sitemaps via the console command, as it causes them to be regenerated twice
• Use a stale-while-revalidate pattern for sitemap generation, so the old cached sitemap will be served until the new one as been regenerated due to an invalidation (content editing) (#1213)

Fixed

• Fixed an issue where the announcement migration would fail due to using closures (changed for the Craft 4.0.0 release)
• Ensure that $driver is nullable in the install migration

Changed

• Check both ENVIRONMENT and CRAFT_ENVIRONMENT when attempt to auto-determine the current environment
• Move to using ServicesTrait and add getter methods for services

Fixed

• Fixed an improper docblock typing for the genericImage property on the Entity model (#1193)

Changed

• Add allow-plugins to composer.json to allow CI tests to work
• Handle passed in arrays and ElementQuerys in assetFromAssetOrIdOrQuery()
• Bumped the bundleVersion to ensure that meta bundles are updated with the new settings

Fixed

• Display a more accurate environment message if they are manually setting the SEOmatic Environment (#1186)

Changed

• Require nystudio107/craft-twigfield version ^1.0.9
• Add an additional CP route for Solspace Calendar, which allows characters like -'s in their handles (#1170)

Fixed

• Fixed an issue where the ads.txt, humans.txt, robots.txt, and security.txt preview links in the CP would 404 on a site where the primary site URL wasn't a root URL (#1168)
• Fixed an issue with some of the default values in seomatic-config for Twitter meta tags (#1171)

Fixed

• Fixed issues with some of the default values in seomatic-config for the productmeta

Fixed

• Fixed issues with some of the default values in seomatic-config that would cause some meta values to be unparsed (#1164)

Added

• Integrated Twigfield into SEOmatic, so fields that allow Twig expressions now have an editor with full autocomplete of the Craft and SEOmatic APIs
• SEOmatic SEO Settings fields do not utilize the Twigfield editor, to keep things simple for content authors (though they still parse as Twig expressions)
• Switched the default Twig expressions from single-bracket { } to double-bracket {{ }} for consistency's sake in the seomatic-config settings (single-bracket expressions still work, however)

Changed

• The SEO Keywords field no longer uses a tokenized input, to allow for the use of the Twigfield editor
• Updated the docs to add The Meta Cascade to the Overview section to better explain how SEOmatic works

Changed

• Only strip the tokenParm URL parameter from the canonical URL, leaving others intact if explicitly set by the developer (generally query strings should not be in canonical URLs, but there are exceptions)
• Don't provide link to Plugin Settings or allow them to be accessed without permission, or without allowAdminChanges being enabled (#1150)

Fixed

• Fixed an issue where a pinned version of davechild/textstatistics caused SEOmatic to not work with other plugins that required a more recent version of the package (#1153)
• Fixed an issue where a GraphQL frontendTemplates request for a disabled file results in error (#1156)
• Fix security.txt template (#1154)

Added

• Added Schema.org v14 JSON-LD models, generated via SchemaGen (#1092)

Changed

• Removed Bing from SEARCH_ENGINE_SUBMISSION_URLS due to it being deprecated (#1043)

Fixed

• Don't allow the autocomplete object inspection to recurse infinitely, set a cap of 10 levels deep (#1132)

Fixed

• Ensure the constant Seomatic::SEOMATIC_PREVIEW_AUTHORIZATION_KEY has public access

Added

• Initial Craft CMS 4 release

Fixed

• Fixed an issue that would throw an exception if using Feed Me with SEOmatic (#1125)
• Fixed an issue where incorrectly namespaced tab ids caused the tabs to not function in SEO Settings fields (#1131)

Changed

• Don’t use deprecated TypeManager::prepareFieldDefinitions()
• Pass through all siteUrl() parameters in the Helper service (#1114)
• Ensure that the currentSite is set to the requested one when processing headless requests via API endpoint or GraphQL, to ensure things like siteUrl() etc. resolve correctly (#1111)
• Remove all ::craft3* version static variables, and the conditional code they depend on
• Use the native str_contains() over StringHelper::contains() (which is slower, and allocated objects, etc.)

Fixed

• Fixed an issue where the Autocomplete helper could throw an exception if it encountered a ReflectionUnionType
• Add box-content class on the code editors, to adjust for the new Tailwind CSS reset in v4
• Fixed an issue where none of the Site Settings changes could be saved (#1107)
• Fixed an issue with the default Humans.txt implementation of parseEnv() (#1109)
• Fixed a validation issue due to incorrect typing that caused the Plugin Settings to be unable to be saved (#1112)
• Dynamically change [0] to .collect()[0] in certain MetaGlobalVars fields so Asset Query accesses will work with Craft 4
• Change [0] to .collect()[0] so Asset Query accesses will work with Craft 4

Changed

• Only regenerate sitemaps via queue jobs if they are a result of an invalidation of the sitemap cache (#1098) (#1097)
• Add typing to the Settings model

Fixed

• Fixed an issue where disabled entries could appear in breadcrumbs JSON-LD (#1088)
• Fix an issue where the cacheDuration setting could throw an exception (#1102)

Fixed

• Changed SuperTableBlockTypeModel::getFields() to getCustomFields()
• Changed MatrixBlockType::getFields() to getCustomFields()
• Fixed an issue that could cause an exception to be thrown during a console request (#1080)

Fixed

• Fixed an issue in the TwigExpressionValidator class that prevented you from accessing the seomatic. variable in some circumstances (#1076)
• Fix AssetTransform/Volume classes for Craft CMS 4
• Fix registering permissions (#1081)

Changed

• Added validation rules for metaCacheDuration property on the Settings model
• Change the default email address in security.txt to the placeholder user@example.com
• The ads.txt and security.txt templates are no longer enabled by default, because they require configuration before use (#1077)

Fixed

• Fix issues with editable table fields, due to the change in default values for Craft 4
• Ensure that the metaCacheDuration is normalized to 0 if set to null or 'null'

Fixed

• Updated types for Craft CMS 4.0.0-alpha.1 via Rector

Changed

• MetaJsonLd::create() now also looks for class names prefixed with Schema_
• Updated types for Craft 4
• Don’t exclude /src/models/jsonld from rector config

Fixed

• Fixed generated JSON-LD classes with invalid class names

Added

• Initial Craft CMS 4 compatibility