airesvsg/acf-to-rest-api

在 WordPress REST API 中公开高级自定义字段端点

3.3.3 2022-03-03 00:08 UTC

This package is auto-updated.

Last update: 2024-09-10 23:10:06 UTC


README

高级自定义字段 中公开端点至 WordPress REST API

https://wordpress.org/plugins/acf-to-rest-api/

安装

  1. acf-to-rest-api 文件夹复制到您的 wp-content/plugins 文件夹
  2. 通过插件管理页面激活 ACF to REST API 插件

端点

过滤器

如何使用过滤器的基本示例,在这种情况下,我将设置一个新的权限来获取字段

add_filter( 'acf/rest_api/item_permissions/get', function( $permission ) {
  return current_user_can( 'edit_posts' );
} );

已弃用的过滤器

请求 API 版本

见下文了解如何选择请求 API 版本。

  1. 打开插件页面;
  2. 点击插件名称(ACF to REST API)下的设置链接;
  3. ACF to REST API 会话中选择您的版本;
  4. 点击按钮“保存更改”。

另一种选择是在您的 wp-config.php 中定义常量 ACF_TO_REST_API_REQUEST_VERSION

define( 'ACF_TO_REST_API_REQUEST_VERSION', 2 );

字段设置

在这个版本中,可以通过管理界面配置字段选项。

这些选项通过以下过滤器启用,默认情况下这些选项是禁用的。

// Enable the option show in rest
add_filter( 'acf/rest_api/field_settings/show_in_rest', '__return_true' );

// Enable the option edit in rest
add_filter( 'acf/rest_api/field_settings/edit_in_rest', '__return_true' );

编辑字段

字段应发送到键 fields

操作: http://localhost/wp-json/acf/v3/posts/1

<form action="http://localhost/wp-json/acf/v3/posts/1" method="POST">
  <?php 
    // https://developer.wordpress.org/rest-api/using-the-rest-api/authentication/
    wp_nonce_field( 'wp_rest' ); 
  ?>
  <label>Site: <input type="text" name="fields[site]"></label>
  <button type="submit">Save</button>
</form>

操作: http://localhost/wp-json/wp/v2/posts/1

<form action="http://localhost/wp-json/wp/v2/posts/1" method="POST">
  <?php 
    // https://developer.wordpress.org/rest-api/using-the-rest-api/authentication/
    wp_nonce_field( 'wp_rest' ); 
  ?>
  <label>Title: <input type="text" name="title"></label>
  <h3>ACF</h3>
  <label>Site: <input type="text" name="fields[site]"></label>
  <button type="submit">Save</button>
</form>

使用过滤器 acf/rest_api/key 来更改键 fields

add_filter( 'acf/rest_api/key', function( $key, $request, $type ) {
  return 'acf_fields';
}, 10, 3 );

现在,字段应发送到键 acf_fields

<form action="http://localhost/wp-json/acf/v3/posts/1" method="POST">
  <?php 
    // https://developer.wordpress.org/rest-api/using-the-rest-api/authentication/
    wp_nonce_field( 'wp_rest' ); 
  ?>
  <label>Site: <input type="text" name="acf_fields[site]"></label>
  <button type="submit">Save</button>
</form>

示例

用于编辑 ACF 字段的示例主题。

https://github.com/airesvsg/acf-to-rest-api-example

待办事项列表 🆕

https://github.com/airesvsg/to-do-list-acf-to-rest-api

递归获取 ACF 字段🆕

https://github.com/airesvsg/acf-to-rest-api-recursive

更多详情

缓存

为 WordPress REST API 启用缓存并提高应用程序的速度。

https://github.com/airesvsg/wp-rest-api-cache