README

存档项目

该项目自2024年8月起已被存档，因为它不再接收活跃的开发。SDK工具和相关项目提供的架构仍然有效，并将继续在Pantheon AGCDN上工作。然而，我们不会回应问题或拉取请求，也不会进一步构建这些工具。

欢迎来到Pantheon边缘集成WordPress SDK！

此存储库作为将WordPress站点与我们的边缘集成工具集集成的单点解决方案。

架构

以下图表展示了SDK提供的概述以及各个组件如何结合在一起。

描述

Edge Integrations WordPress SDK由多个组件组成，除了存储在本存储库中的文档外，当你在WordPress项目根目录中执行composer require项目时，所有这些组件都会自动安装。

Pantheon高级全球CDN

边缘集成从“边缘”本身开始，即在浏览器中渲染页面之前的最后一个CDN层。Pantheon的高级全球CDN已在我们的AGCDN平台上启用了Varnish配置规则，允许地理位置信息和兴趣跟踪数据在CDN之间来回发送，从而实现CDN缓存针对这些参数个性化的内容。AGCDN是Pantheon Edge Integrations的第一步，使我们能够渲染个性化页面的缓存版本。

Pantheon边缘集成全局库

Pantheon Edge Integrations全局库允许开发人员与发送到和从CDN发送的标题数据交互。这是一个低级接口，简化了与CDN发送的标题通信和解释的过程。重要的是要注意，Edge Integrations库被构建为一个通用的、CMS无关的PHP包，并用作WordPress和Drupal实现的基础。

Pantheon WordPress边缘集成插件

WordPress Edge Integrations插件添加了有命名空间的功能（例如Pantheon\EI\WP\get_geo()和Pantheon\EI\WP\get_interest()），挂钩和过滤器，可以赋予WordPress开发者使用我们的边缘集成进行个性化的能力，而无需直接与全局库交互。它包括一些有见地的辅助函数，引导我们的函数的参数和返回值，并实现基于帖类别的兴趣跟踪（默认情况下）。

Pantheon地理位置简码插件

《Pantheon Geolocation Shortcodes》插件是一个可选的附加组件，如果您只想在某些特定地理区域内显示特定内容，而不在其他地理区域内显示，则可以包含该插件。该插件提供了通过大陆、国家、地区和城市显示内容的参数，并支持如not_continent和not_city等条件。

Pantheon Edge Integrations Consent Management插件

《Pantheon Edge Integrations Consent Management》插件是另一个可选的附加组件，可以用来启用与Pantheon Edge Integrations集成原生的cookie同意横幅。它可以作为一个现成的同意管理解决方案使用，也可以作为开发具有Edge Integrations的自定义同意管理解决方案的框架，或者作为集成第三方同意管理插件的参考。

设置

使用Composer安装

将Edge Integrations支持添加到您的Composer项目非常简单，也是添加Edge Integrations WordPress SDK的推荐方法。

要求Composer包

要开始，您只需将此存储库添加为依赖项即可。

composer require pantheon-systems/edge-integrations-wordpress-sdk

该命令将此存储库添加到您的/vendor目录中，以及所有依赖项，包括一个全局、CMS无关的PHP库和一个WordPress插件，以及SDK的所有文档。

或者，您可以将pantheon-systems/edge-integrations-wordpress-sdk作为依赖项添加到项目的composer.json文件中，并运行composer install。

手动安装

如果您在项目中根本不使用Composer，您仍然可以轻松开始使用WordPress Edge Integrations插件。在这种情况下，您不会安装SDK包，而是前往Pantheon WordPress Edge Integrations发布页面。

• 下载与最新版本关联的源代码（zip）文件。
• 在您的wp-content/plugins目录中提取插件。您将获得所有编译的资源和包含的依赖项，包括包中的CMS无关的全局PHP库。

激活插件

在两种情况下，最后一步都是从WordPress仪表板的插件页面激活插件。WordPress插件没有其他管理界面——所有功能和组件都由代码本身处理，开发人员可以使用钩子与地理位置和兴趣跟踪功能交互。