93devs/nine3-workable-api

dev-master 2022-02-15 15:53 UTC

This package is auto-updated.

Last update: 2024-09-15 21:53:07 UTC


README

v1.0.1

作者: Ahmad Al Asadi & Matt Knight

这是一个WordPress的API类,用于从Workable招聘平台上的账户获取职位空缺。获取的数据以WordPress瞬态的形式存储,从而允许快速方便地访问数据。

安装

通过Composer安装

$ composer require 93devs/nine3-workable-api:dev-master

然后在主题配置文件(例如functions.php)中实例化该类

/**
 * @param string $subdomain The subdomain part of the URL of a Workable account.
 * @param string $access_token An access token generated within the Workable account.
 */
$workable_api = new Nine3_Workable_Api( $subdomain, $access_token )

方法

该类将在实例化时自动设置一个小时的cron作业,该作业将执行API请求并将响应作为瞬态存储(假设WP-Cron没有被禁用!)。

但是,也有一些公开可用的方法。

获取空缺职位

返回Workable账户上已发布的所有空缺职位的完整列表。这将返回存储在瞬态中的数据。如果瞬态为空或未找到,将执行新的API请求。

用法

/**
 * @return array A multi-dimensional array containing all vacancy data.
 *
 * @see https://workable.readme.io/docs/jobs For available keys in each vacancy. An extra `description` key will also have been added by the class.
 */
$workable_api->get_vacancies();

获取空缺职位

强制对Workable平台进行新的API请求以获取最新的空缺职位数据。瞬态将被返回的响应更新。

/**
 * @param bool $return [optional] Whether to return the fetched vacancies data.
 *
 * @return array A multi-dimensional array containing all vacancy data.
 *
 * @see https://workable.readme.io/docs/jobs For available keys in each vacancy. An extra `description` key will also have been added by the class.
 */
$workable_api->fetch_vacancies( $return = false );

更多信息

Workable API参考: https://workable.readme.io/