moxie-lean/wp-endpoints-static

通用的但可定制的端点,用于通过WP-API公开我们的静态数据。

2.1.0 2016-07-14 15:32 UTC

This package is auto-updated.

Last update: 2024-08-28 09:35:43 UTC


README

通用的但可定制的端点,用于通过WP-API公开我们的静态数据。此扩展将创建一个端点(默认为`/wp-json/leean/v1/static`)。

该端点不接受任何参数,并返回以下数据

  • 站点名称
  • 站点标语
  • 菜单
    • 菜单位置
      • 菜单项
  • 小部件

入门指南

安装此包最简单的方法是在终端中使用composer

composer require moxie-lean/wp-endpoints-static

或者在您的composer.json文件中添加以下行

"require": {
  "moxie-lean/wp-endpoints-static": "dev-master"
}

这将从packagist站点下载文件,并设置您位于存储库master分支的最新版本。

之后,您可以通过包含autoload.php文件来在对象创建时自动加载类。

include '/vendor/autoload.php';

最后,您需要通过在代码中添加以下内容来初始化端点

\Lean\Endpoints\StaticApi::init();

用法

此扩展具有多个过滤器,可用于自定义输出。此外,它对ACF数据进行了一些有用的额外操作,使其对前端应用更有用。

过滤器

许多过滤器传递的常见参数包括

  • $endpoint : 端点名称。对于此扩展始终为'/static'。

ln_endpoints_api_namespace

自定义API命名空间(在`/wp-json/leean/v1/static`中的'leean')

add_filter( 'ln_endpoints_api_namespace', function( $namespace, $endpoint ) {
    return 'my-app';
}, 10, 2 );

ln_endpoints_api_version

自定义API版本(在`/wp-json/leean/v1/static`中的'v1')

add_filter( 'ln_endpoints_api_version', function( $version, $endpoint ) {
    return 'v2';
}, 10, 2 );

ln_endpoints_data

自定义发送之前的结果。

add_filter( 'ln_endpoints_data', function( $data, $endpoint ) {
    $data['site_title] = 'New Title;
    return $data;
}, 10, 3 );