README

本插件将提供连接并从 REMP CRM 获取 API 数据的功能。

安装

从本仓库下载此包，并将其复制到 WP 安装的 /wp-content/plugins 目录，然后在此文件夹中运行 composer install 以下载依赖项。然后前往管理面板，在插件管理部分激活插件。

如果您使用 Bedrock WP 安装，只需通过 composer 命令安装即可。

composer require payter/wp-remp-user-helper:dev-master

配置

插件提供了一些 PHP 常量，其中一个是必须配置的。请将以下内容添加到 wp-config.php 中，并设置您的当前 REMP CRM 域名。

define('REMP_URL', 'http://remp.crm.domain');

请检查其他需要配置的常量，见 wp-remp-user-helper.php

可用的函数

插件使用函数式编程，所以所有功能都被封装在函数中，并可供使用。所有功能都是位于 lib 目录中的 PHP 文件。

API 函数

连接并从 REMP CRM API 获取数据的 API 函数。最常用的函数之一

// Get parsed data from api or null
remp_api_data($url, $options = [], $method = 'GET'); 

// Will connect to the REMP API and return back Guzzle client object
remp_api_client($url, $options = [], $method = 'GET')

缓存函数

用于存储结果的缓存函数。由于 API 连接操作成本较高，因此存储结果在缓存中非常重要。您可以在 mu-plugins 文件夹中用自己的函数替换此函数

remp_cache_key($key);
remp_cache_get($key, $group = REMP_CACHE_KEY_GROUP, $force = false);
remp_cache_set($key, $data, $group = REMP_CACHE_KEY_GROUP, $expire = REMP_CACHE_EXPIRATION);

辅助函数

其他有用的函数

// Will generate url to the REMP CRM by passing url path as argument
remp_get_url($url_path = '');

用户 API 函数

使用此函数检索用户信息

// Check, if user is logged in REMP
remp_user_logged_in();

// Retrieve user info from API
remp_user_get_info();

// Retrieve all subscriptions from API for logged user
remp_user_get_subscriptions();

// Check by subscriptions, if user have currently active subscription
remp_user_is_premium();

payter / wp-remp-connector

维护者

详细信息