README

此WordPress插件将核心Web Vitals数据发送到Google Analytics。它与Web Vitals Report兼容

安装

此插件可以作为Composer依赖项安装

composer require xwp/site-performance-tracker

或者从发布页面下载插件ZIP文件。

使用

必须通过设置site_performance_tracker_vitals主题功能并使用您的Analytics ID来配置此插件。收集的数据将在几天后可在Web Vitals Report中可用。

为了将Web Vitals指标以与Web Vitals Report兼容的格式发送到Google Analytics，请启用以下主题支持并传入ID

GA4 Analytics受支持，需要使用ga4_id传递ID

add_theme_support( 'site_performance_tracker_vitals', array(
  'ga4_id' => 'G-XXXXXXXXXX',
) );

以下钩子可以添加到主题或自定义插件中以配置插件，或者您也可以通过设置屏幕配置插件，在发生重复时，插件将采用程序设置。要确认它们已被应用，请查找页面源中的全局变量webVitalsAnalyticsData。

限制发送的事件数量

以下过滤器可用于将跟踪事件的数量限制为流量的一定百分比。例如，要将跟踪事件限制为请求的5%，请使用以下逻辑

add_filter( 'site_performance_tracker_chance', function() {
  return 0.05;
} );

禁用跟踪

程序化禁用插件。

add_filter( 'site_performance_tracker_disabled', '__return_true' );

延迟脚本加载

程序化延迟Web Vitals跟踪以最小化对交互性的影响。默认情况下，空闲回调请求将被推迟5000毫秒，该值可以通过过滤器进行调整

add_filter( 'site_performance_tracker_web_vitals_delay', function() {
  return 1000;
} );

贡献

欢迎所有贡献！请为错误和功能请求创建问题，并使用拉取请求进行代码贡献。

项目设置

• 我们使用wp-env进行本地开发环境。有关支持的命令和辅助工具，请参阅package.json中的所有env:*脚本。

• webpack.config.js配置了如何在打包期间将JS和CSS资产转换为@wordpress/scripts。

• 由于Prettier集成在@wordpress/scripts中目前不可靠，因此我们使用@wordpress/eslint-plugin/recommended-with-formatting规则集进行JS代码审查。

更改日志

1.3.5 - 2023年7月28日

• 添加了对使用window.dataLayer设置GA4的Google Tag Manager的跟踪支持。

1.3.4 - 2023年7月15日

• 修复了当某些归因项为空时INP报告中出现的错误。

1.3.3 - 2023年6月26日

• 弃用了GA3支持。
• 使用Web Vitals的归因构建。

1.3.2 - 2023年10月30日

• 改进了GA4的管理界面。
• 提高构建过程以使用Node 16。

1.3.1 - 2023年7月18日

• 更新GA4设置。
• 将WP-Rocket排除在web-vitals-analytics之外。
• 清理/重构设置代码。

1.3 - 2023年2月24日

• 添加INP指标。
• 支持更小的web vitals比率。

1.2 - 2022年12月5日

• 清理设置代码。

1.1.7 - 2022年7月5日

• 修复GA投递错误。

1.1.6 - 2022年5月18日

• 修复使用UI时GA不跟踪的bug。

1.1.5 - 2022年3月17日

• 添加TTFB。

1.1.4 - 2022年3月10日

• 通过在较安静的时段加载和执行脚本来提高性能。
• 将块哈希作为输出文件名的一部分。

1.1.3 - 2022年3月9日

• 修复UI以预填充配置数据。

1.1.2 - 2022年3月4日

• 修复使用gtag时重复的页面浏览。

1.1.1 - 2022年3月3日

• 修复使用gtag时的重复页面浏览。
• 修复PHP通知。

1.1.0 - 2022年1月6日

• 在WordPress管理后台引入UI，以简化配置。如果主题文件中设置了任何配置参数，则UI将不允许更改这些参数。

1.0.0 - 2021年10月4日

• 更新文档，以将“用法”部分从插件需要进行的配置开始。
• 切换到基本的PHP包含，用于加载PHP文件，而不是使用Composer自动加载。
• 引入用于处理资产路径和URL的辅助方法。
• 引入VIP Go编码标准。
• 引入PHP单元测试。

0.9.1 - 2021年7月9日

• 修复configureGtag调用。

0.9 - 2021年6月16日

• 将web vitals JS库更新到2.0.1。

0.8 - 2021年5月28日

• 删除Performance Observer功能。
• 代码清理。

0.7 - 2021年5月26日

• 添加对Google Analytics 4的支持。

0.6 - 2021年5月25日

• 修复Google Analytics支持。
• 代码清理 - 删除未使用的指标和维度。

0.5 - 2021年4月13日

• 功能：添加对以web vitals报告格式发送数据的支持。

0.3.1 - 2020年3月11日

• 功能：添加对通过Google Tag Manager添加的分析的支持。

0.3.0 - 2020年3月11日

• 功能：跟踪超过100ms的'first-delay'。

0.2.0 - 2019年2月22日

• 将autoload.php设置为可选，以支持项目范围内的自动加载。
• 添加一个名为xwp/performance_tracker/render_mark的操作，作为在前端添加性能标记的替代方法。
• 错误修复：使用正确的JS转义（根据WordPress VIP审查）。

0.1.1 - 2019年2月18日

• 插件不再使用单例模式。而是只是一个普通的类，在主插件文件中被实例化。
• 已添加命名空间。
• 已添加PHP版本检查（>= 5.3）。
• 将辅助函数提取到单独的文件中，并且它们现在在类内部使用静态函数。
• 不再将$default_entry_types数组定义为静态。

0.1.0 - 2019年2月15日

• 初始发布。

贡献

请遵循贡献指南。

致谢

由XWP和贡献者创建。许可协议为GNU通用公共许可证v2.0或更高版本。