site-kit-wp

Added

• Introduce base components for upcoming Site Kit Widgets API. See #1300.

Enhanced

• Rename wp google-site-kit auth revoke to wp google-site-kit auth disconnect and adjust internal CLI commands infrastructure. See #1677.
• Significantly improve stability and maintainability of Optimize module setup and settings, and fix bug where editing Optimize settings with AMP active could cause an error due to the ampExperimentJSON module setting not being stored as JSON string. See #1621.
• Add hasScope( scope ) selector to core/user store, which allows checking whether the user has explicitly granted access to the respective scope. See #1610.
• Introduce modules/tagmanager datastore to enable JS-based access to Tag Manager data. See #1385.
• Allow specifying Analytics view name when creating a new one, and display a deep link to modify view settings in Analytics module settings. See #716.

Fixed

• Fix admin tracking regression where snippet would not be loaded on the page. See #1717.
• Ensure ad blocker detection is active throughout the entire AdSense module setup. See #1666.
• Fix redirect to Google Analytics terms of service occasionally failing due to unnecessary extra redirect. See #1632.
• Fix bug Cannot read property 'destroy' of undefined from AMP experiment JSON field in Optimize module. See #1605.

Learn more about the new feature in this release

Added

• Implement new version of PageSpeed Insights widget that focuses on core web vitals. See #1636.
• Introduce modules/optimize JS datastore for Optimize module. See #1620.

Enhanced

• Detect current URL and related data when on the Site Kit screen for single URL details. See #1653.
• Implement tabbed UI for new web vitals widget separating between mobile and desktop as well as lab and field data. See #1649.
• Only load Site Kit-specific Analytics script on Site Kit admin screens. See #1648.
• Pass user_roles query parameter during setup. See #1639.
• Simplify module datastore creation by including commonStore in the store returned googlesitekit.modules.createModuleStore. See #1607.
• Add selectors to get module-specific admin screen URLs to every module datastore. See #1559.
• Fix accessibility issues in Site Kit settings due to semantically incorrect tag usage. See #1557.
• Add getReport selector to modules/pagespeed-insights datastore to get UX reports. See #1426.
• Implement meta programming approach for API-based datastore selectors and actions to reduce boilerplate. See #1288.
• Include anchor link in success notification after setting up PageSpeed Insights module. See #532.

Fixed

• Reduce bundle size of Analytics and Optimize module JS assets. See #1661.
• Do not run Site Kit assets logic when not applicable for the current user, avoiding unnecessary checks e.g. on the login screen. See #1650.
• Fix incompatibility with WooCommerce due to Webpack conflict. See #1637.
• Fix bug with event firing when activating or deactivating a module. See #1629.
• Enhance functionality of new core/modules store so that module activation/deactivation results in authentication data to be refreshed. See #1507.
• Fix ad blocker detection failing for popular AdBlock browser extension. See #1491.
• Ensure dashboard search form can only be submitted with valid content. See #1434.
• Fix Analytics data displayed for Users being partially incorrect due to incorrect date parsing. See #1394.
• Fix table content overflow issues in narrow viewports. Props AlexandreOrlowski. See #1376.

Added

• Introduce modules/pagespeed-insights datastore in JS. See #1500.
• Introduce modules/search-console datastore in JS. See #1498.
• Implement Site Kit widgets API datastore wrapper on googlesitekit.widgets. See #1301.
• Introduce core/widgets datastore for Site Kit widget registrations. See #1298.
• Integrate with the Analytics Provisioning API to enable creation of Analytics accounts directly from the plugin. See #1271.
• Introduce modules/adsense JavaScript datastore with core functionality for the AdSense module. See #1247.
• Add create-account-ticket datapoint for Analytics module that creates a new Analytics account ticket using the Provisioning API. See #1212.
• Add notifications functionality to core/user store. See #1177.
• Introduce core/user datastore for managing user-specific data in JS. See #1175.

Enhanced

• Only request readonly OAuth scopes for each module by default, and prompt for additional scopes when needed for a specific action. See #1566.
• Wrap all JavaScript apps into Root component with essential providers, error handlers etc. See #1530.
• Introduce core/forms datastore to manage form state. See #1510.
• Render amp-analytics snippet for Web Stories. See #1506.
• Migrate PageSpeed Insights settings to using the datastore. See #1501.
• Display actual Search Console property used in settings, and migrate to using the datastore. See #1499.
• Rename Analytics profiles to views consistently. See #1486.
• Improve AdSense account status and site status detection logic to be more error-proof. See #1332.
• Add user profile information and verification state to core/user datastore. See #1176.
• Significantly improve stability and maintainability of AdSense module setup and settings. See #1014.
• Clarify message for when user needs to reauthenticate to grant required scopes. See #189.

Fixed

• Ensure all module caches are cleared when modifying Analytics settings. See #1593.
• Fix bugs where CTAs to link Analytics to AdSense would never show. See #1545.
• Fix AdSense report URL to not include user-specific affix. See #1516.
• Fix Search Console deep links to use the correct property identifier. See #1497.
• Fix bug where having a graylisted AdSense account would prevent the AdSense code from being placed. See #1494.

This release includes security fixes. An update is strongly recommended.

Enhanced

• Check for users that verified through Site Kit without being authorized to do so, and disconnect them from Site Kit. See #1573.
• Provide application_name query parameter to authentication service. See #1571.

This release includes security fixes. An update is strongly recommended.

Added

• Introduce standalone UI mode for plugin admin screens. Props EvanHerman. See #1281.
• Introduce modules/analytics datastore for managing Analytics state in JS. See #1224.
• Introduce core/modules datastore for managing module information and activation state. See #1179.

Enhanced

• Preload REST API datapoints for core/site and core/user datastores to avoid firing these extra requests. See #1478.
• Add support for new Optimize container IDs starting in OPT-. See #1471.
• Improve alignment of dialog buttons. See #1436.
• Rely on the default profile specified in an Analytics property for the profile to pre-select in the dropdown in Analytics setup/settings. See #1404.
• Remove periods from single sentences in settings panel lists. See #1401.
• Add googlesitekit.data.combineStores utility function to combine multiple datastore objects. See #1400.
• Significantly improve stability and maintainability of Analytics module setup and settings. See #1101.
• Update Analytics control for whether to place snippet to use a toggle instead of radio buttons for consistency. See #1048.

Fixed

• Fix bug where Analytics would never request AdSense metrics even with a successful AdSense connection. See #1524.
• Fix bug where amp-auto-ads snippet would not always be printed if the theme didn't support the wp_body_open action. See #1495.
• Do not request remote notifications if the site is not connected to the remote. See #1479.
• Update registered site name on authentication service when it is updated in WordPress. See #1397.
• Display only paths instead of full URLs in Analytics tables for better visibility and consistency with Analytics frontend. See #1116.
• Add missing translator comments to ease plugin localization for contributors. See #820.

Added

• Add notifications functionality to core/site datastore. See #1174.

Enhanced

• Add rollbackSettings action to settings datastores and refine overall datastore infrastructure. See #1375.
• Expand AdSense settings panel to expose more helpful information. See #585.

Fixed

• Fix bug where similar batch request to the API could occur multiple times. See #1406.
• Fix bug where single post stats would display the unique visitors from Search for the overall site instead of only that post. Props phamquangbaoplus. See #1371.
• Fix Analytics incorrectly triggering re-authentication notice when the user does not have any accounts. See #1368.
• Fix JS datastore actions to never have an associated control and reducer at the same time. See #1361.
• Place Tag Manager snippet for non-JavaScript support after opening body tag as commonly expected. Props ShahAaron. See #1308.
• Fix layout issue in Tag Manager settings panel when no container is selected. See #1296.
• Fix issue related to added _gl query parameter from AMP linker. Props ShahAaron. See #1275.

Enhanced

• Allow modules to register and enqueue their own assets by implementing a Module_With_Assets interface. See #1319.
• Decouple datastores from global registry by using createRegistryControl and createRegistrySelector. See #1287.
• Update datastore resolvers to only issue API requests when lacking data. See #1286.
• Add preloading middleware for REST API data and preload module settings routes on pageload. See #1246.
• Add more granular selectors to the core/site datastore. See #1173.
• Add several additional selectors for commonly used site data to the core/site datastore. See #1000.

Fixed

• Fix bug where plugins modifying the site address during frontend requests would prevent the setup flow from being completed. See #1357.
• Fix bug where googlesitekit.api.set would not pass through request data correctly to the API endpoints. See #1346.
• Fix bug where using a WordPress locale with a third segment (e.g. formal variant) would cause JavaScript errors on some screens. See #1309.
• Do not revoke token remotely when token is deleted, unless explicitly requested via disconnect. See #1305.
• Fix unicode domains being displayed in punycode version in disconnect feedback message. See #1297.
• Fix bug where certain numbers were rounded differently from how the respective Google service rounds them. See #1279.
• Optimize JavaScript dependency loading, decreasing the chance of conflicts and reducing the plugin size. See #1222.
• Ensure the total user count in the Analytics module matches the numbers displayed in the Google Analytics frontend. See #1202.

Added

• Add support for reading and editing settings to datastores created via googlesitekit.modules.createModuleStore. See #1249.
• Introduce googlesitekit-modules asset with createModuleStore function to create a base datastore for a Site Kit module. See #1063.

Enhanced

• Ensure module settings are consistently passed from PHP to JavaScript, and fix some minor logic issues in the consuming JavaScript code. See #1245.
• Automatically include a REST route to read and edit settings for every module that supports them. See #1244.

Fixed

• Fix issue where users would get stuck on setup screen after seemingly successful completion of the setup flow on the authentication service. See #1266.
• Provide clear error message informing the user when they did not grant the necessary permissions, instead of a generic access_denied error code. See #1192.
• Fix JavaScript errors in AdSense screens that was a result of Intl.NumberFormat.formatToParts not being supported in Safari. See #1107.
• Fix JavaScript error e.replace is not a function in AdSense screens related to formatting numbers. See #1092.
• Fix problems around comparing domains with unicode characters that could result in blocking the plugin setup. See #794.

Fixed

• Ensure tracking opt-out mechanism works consistently between both Analytics and Tag Manager in AMP, and fix regression with Site Kit admin bar menu no longer expanding on AMP pages. See #1251.

Added

• Expose googlesitekit.data registry and register initial core/site store on it. See #999.
• Add user-facing warnings to Site Kit areas when JavaScript is disabled. Props Shavindra. See #177.

Enhanced

• Standardize several REST API route names for consistency with JavaScript API. See #1178.
• Fix various plugin setup issues related to inconsistent URLs by automatically updating registered URIs on the authentication service. See #1034.
• Improve asset handling in PHP by introducing dedicated data-only scripts, to use as dependencies. See #1004.
• Respect Analytics tracking exclusion of logged-in WordPress users also if Tag Manager is used. See #944.
• Integrate with WordPress Site Health feature to provide contextual Site Kit information for support and troubleshooting. See #169.

Changed

• Display helpful link in previously empty PageSpeed Insights settings area. See #1129.
• Use latest product icon for the Optimize module. See #969.

Fixed

• Ensure date range selectors functionality is decoupled from localizable strings. See #1183.
• Fix bugs where some untranslated strings would show despite being translated, caused by too early usage of these strings in JavaScript. See #1163.
• Replace outdated AMP client ID mechanism for tracking AMP traffic with recommended AMP linker approach, and enable it by default. See #1160.
• Fix compatibility error where google.charts.load was not called before google.charts.setOnLoadCallback. See #1155.
• Do not show empty data table in Analytics module screen when there is no data to display. See #464.

Enhanced

• Introduce basic notifications system for information displayed in the Site Kit dashboard. See #1110.
• Register all of the plugin's user options in WordPress via register_meta(). See #1029.
• Improve JS error handling consistently across individual React apps and allow for better contextualization. See #943.
• Display information about lack of data instead of displaying empty top search queries box. Props Shavindra. See #314.
• Ensure admin bar displays when at least Search Console or Analytics have stats for the current URL. See #167.

Fixed

• Fix minor bug causing potentially incorrect token expiry to be recorded. See #1158.
• Fix AMP violations when user is logged in and Site Kit admin bar menu is active. See #1142.
• Fix incompatibility issue with Jetpack by resolving bug where the bundled lodash was causing a conflict. See #1141.
• Fix double-rendered HTML markup on Site Kit dashboard screen. See #1140.
• Fix misleading sparkline color for metrics that should use the inverted color, such as bounce rate. See #1128.
• Work around bug in ModSecurity by relying on only providing granted OAuth scopes in token API response. See #1113.
• Make JS and CSS asset names consistent. Props Shavindra. See #1040.
• Properly support paired AMP in Tag Manager module by allowing to select two different containers, one for web context and the other for amp context. Props kmwilkerson. See #413.
• Fix accessibility issues in dialog component with potentially duplicate IDs and invalid ARIA attributes. See #345.
• Fix issue where disconnecting a user from a site would disconnect that user from all their sites.

Fixed

• Ensure opcache_reset() exists before calling it. See #1136.

Added

• Introduce googlesitekit.data registry for JS datastores. See #997.

Enhanced

• No longer delete plugin data when uninstalling and instead rely on the more explicit reset functionality. See #1069.
• Remove legacy migrations that were only relevant to pre-1.0.0 users. See #1062.
• Migrate stray module settings into object-like option for consistency and future scalability. See #1030.
• Introduce core/site/data/connection REST API route for retrieving site connection info. See #998.
• Fully rely on Webpack for third-party dependencies and decouple from WordPress-shipped assets for more stability across all versions. See #993.
• Inform the site owner about potential issues with their site that will likely cause problems when setting up the plugin. See #933.
• Make opting in to tracking specific per user instead of per site. See #913.
• Bump minimum required PHP version to 5.6, rely on up-to-date linting tools and fix various PHPCS issues. See #547.
• Move REST route definitions into more applicable classes that handle the respective functionality. See #166.

Fixed

• Allow users with existing Tag Manager accounts to create additional accounts during module setup. See #1080.
• Fix partly outdated PHP files being served due to OpCache issues currently not addressed by WordPress core. See #1066.
• Prevent unexpected PageSpeed Insights API responses from breaking the dashboard. See #1061.
• Standardize GA tracking snippets and inconsistent data passed in events by introducing a proper tracking API in JavaScript. See #1055.
• Fix several temporary blank screen errors by loading script dependencies more reliably via Webpack. See #1054.
• Ensure that the Tag Manager snippet rendered is always compatible with the current context (AMP vs non-AMP). See #1036.
• Do not render amp-auto-ads element in AMP stories because it is invalid in that context. See #979.
• Ensure that Google Charts JS library is loaded as expected even when a window.google global already exists because of another library. See #939.
• Do not refetch PageSpeed Insights data when the date range selector is changed, as its data its date-unaware. See #890.
• Fix incorrect change arrow direction and color on "inverted" properties like bounce rate. Props WebFactoryLtd. See #481.
• Add missing support for Search Console domain properties and rely on the correct property when requesting Search Console data. Props IgorCode. See #325.

Added

• Introduce new googlesitekit.api layer for accessing Site Kit datapoints with reliable caching. See #953.
• Detect already existing Tag Manager snippets from other sources and inform about them in the setup flow. See #433.

Enhanced

• Introduce Site Kit-specific Google_Client implementation and use that throughout the codebase. See #1003.
• Reduce maintenance by implementing dynamic activation notice in React. See #991.
• Include platform and plugin version information in API client requests. See #989.
• Ensure that all module settings are properly registered in WordPress for consistent behavior. See #859.
• Allow users to rely on WP_PROXY_* constants to use an HTTP proxy for requests issued by Google_Client. See #661.
• Allow users that have existing Google Analytics account to create a new account in module setup and settings. See #198.
• Remove very limited debug bar integration for now. See #178.

Fixed

• Fix bug and potential JavaScript error where user was able to select Analytics property before selecting an account. See #1039.
• Optimize initialization of the Google API client and minimize JavaScript assets and inline data being loaded in regular requests. See #980.
• Fix Search Console average position graph to show the smallest value on top of the Y axis. Props connorhsm. See #874.
• Display warnings about insufficient scopes across all Site Kit screens instead of only the dashboard, since they are just as relevant during setup. See #729.
• Ensure that PageSpeed Insights module can be deactivated again once activated. See #682.

Enhanced

• Improve compatibility with WordPress VIP environment. Props moraleida. See #901.
• Update wording on setup screen for secondary users to clarify they need to connect their account, but not set up the plugin. See #881.
• Use OAuth login_hint parameter to indicate that the user should use the same Google account across all modules. See #867.
• Anonymize IP addresses by default in Google Analytics snippet, and grant the user control to modify with a new setting. Props gx10. See #18.

Fixed

• Fix compatibility issues with older versions of the AMP plugin. See #975.
• Ensure that only options and user options starting with googlesitekit_ (including underscore) are deleted on reset or disconnect. See #968.
• Optimize disconnecting users by only running a single database query. See #960.
• Ensure Site Kit admin bar content is styled independently from the current theme. See #888.
• Fix bug in Analytics module setup where the user would not be informed about an existing tag before selecting a property. See #803.
• Fix bug where admin bar stats would not display under certain circumstances when editing a post in the backend. See #521.
• Display impressions before clicks in admin bar as that is the commonly expected order. See #297.

Fixed

• Fix critical AdSense issue where users were not able to place the snippet and would end up on a blank screen under certain conditions. See #891.

Enhanced

• Introduce new mechanism for a site to receive its credentials from the authentication service, replacing the previous mechanism using the REST API that was error-prone on certain environments. See #905.

Fixed

• Remove unnecessary logic to refresh an access token on login, since the Google API client already accounts for that. See #903.
• Fix too long request URLs for Google API batch requests to use POST instead, as the query length was problematic on certain environments. Props sksaju. See #779.
• Fix bug resulting in blank plugin dashboard screen under certain circumstances. Props ThomasTr. See #767.
• Ensure that opting in or out of tracking takes effect immediately. See #727.
• Fix spacing issue in Search Console step for local development setup. See #637.
• Fix display of the disconnect modal which could potentially appear below the "section locked" indicator in the plugin settings UI. See #636.

Fixed

• Fix reset and uninstall data removal by optimizing database queries. See #809.

Enhanced

• Update usage of G icon in admin menu, dashboard widget and screen options to align better with WordPress admin UI. See #877.
• Add support for site verification via file as primary method while keeping site verification via meta tag as fallback, resolving potential site verification failures. See #836.
• Move checkbox above submit button in setup screen and banner for better accessibility. See #788.
• Use more secure nonce generation mechanism for the authentication service. See #756.
• Show PageSpeed Insights performance stats for every individual URL in its details view, accessible from Site Kit dashboard and admin bar. See #654.
• Display Tag Manager container names instead of IDs in dropdowns for more user-friendly selection. See #591.
• Remove redundant notification title for AdSense notifications. Props OisinOConnor. See #586.
• Always use root domain for AdSense site because subdomains are typically not supported. Props OisinOConnor. See #578.
• Add support for displaying the full Site Kit admin bar menu with stats also for AMP requests, by leveraging AMP's dev mode feature. See #438.
• Simplify AdSense account status detection as a base for easier future enhancements and fixes. See #427.
• Add a checkbox to allow disabling Analytics tracking for logged-in users, and introduce a filter to adjust the behavior programmatically. Props Paras16699. See #88.

Fixed

• Ensure that a newly created Tag Manager container is properly saved so that the module setup is completed. See #821.
• Improve detection of existing AdSense snippets to cover more variants of snippets. See #798.
• Only display the Reset button on the setup screen if there actually is something to reset, and provide a feedback notice. See #758.
• Update incorrect message in development setup flow referring to site verification instead of Search Console. Props AVGP. See #600.
• Only show Tag Manager containers that are relevant to the site's mode, and accordingly support AMP-first by only exposing AMP containers. See #470.

Fixed

• Fix critical bug causing unnecessary requests to Google People API although no user is logged-in. See #854.