ashleyfae / contextwp-sdk
与ContextWP集成的WordPress插件
1.0.0
2024-07-27 11:07 UTC
Requires
- php: >=7.1
- ashleyfae/wp-db: dev-main
Requires (Dev)
- 10up/wp_mock: 0.4.2
- mockery/mockery: ^1.5
- phpunit/phpunit: ^9.5.20
README
一个用于与ContextWP集成的即插即用库
使用方法
针对定制使用,请参阅ContextWP中的集成说明。
更通用的使用方法如下
使用Composer将此包包含在您的插件中
composer require ashleyfae/contextwp-sdk
确保您的WordPress插件已包含自动加载文件,如果尚未包含的话
require_once __DIR__.'/vendor/autoload.php';
然后注册您的产品
add_action('contextwp_sdk_loaded', function (\ContextWP\SDK $sdk) { $sdk->register( (new \ContextWP\ValueObjects\Product('PUBLIC_KEY_HERE', 'PRODUCT_UUID_HERE')) ); });
您可以从ContextWP产品仪表板获取您的公钥和产品UUID。
收集您的插件版本号
默认情况下,SDK将包含非插件特定的环境信息,例如PHP版本、WordPress版本等。您还可以通过使用setVersion()
方法在数据中包含您的插件版本号
add_action('contextwp_sdk_loaded', function (\ContextWP\SDK $sdk) { $sdk->register( (new \ContextWP\ValueObjects\Product('PUBLIC_KEY_HERE', 'PRODUCT_UUID_HERE')) ->setVersion($yourVersionHere) ); });
测试
如果您想测试SDK是否正确设置并正在运行,可以运行此WP-CLI命令
wp contextwp checkin
如果它正常工作,您应该看到以下输出(UUID将不同)
Sending check-ins for PK: af272e18-bea7-42fd-b531-f898fbd55b25
Response code: 202
Response body: {"accepted":["ca9d46ca-d5b7-4a85-8411-aeec690a6d26"],"rejected":[]}