moxie-lean/wp-endpoints-admin-bar

通用端点,通过WP-API公开管理栏配置。

1.1.1 2016-07-18 21:39 UTC

This package is auto-updated.

Last update: 2024-08-28 09:53:18 UTC


README

通用端点,通过WP-API公开管理栏配置。此扩展默认将创建一个端点(在`/wp-json/leean/v1/admin-bar`)。

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

  • 网站名称
  • 当前用户
  • 管理员URL
  • 注销URL
  • 编辑页面URL
  • 新项目
    • 新项目名称
    • 新项目URL

入门指南

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

composer require moxie-lean/wp-endpoints-admin-bar

或者通过在你的composer.json文件中添加以下行

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

这将从Packagist网站下载文件,并设置从存储库的master分支中找到的最新版本。

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

include '/vendor/autoload.php';

最后,你需要通过将以下内容添加到你的代码中来初始化端点

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

用法

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

过滤器

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

  • $endpoint : 端点名称。对于此扩展始终是'/admin-bar'。

ln_endpoints_api_namespace

自定义API命名空间('leean'在`/wp-json/leean/v1/admin-bar`

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

ln_endpoints_api_version

自定义API版本('v1'在`/wp-json/leean/v1/admin-bar`

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_name'] = 'New Site Name';
    return $data;
}, 10, 3 );