如何修改wp-json-api媒体响应


How to modify wp json api media response

我正试图为'/media'端点的wp-json-api响应添加一个额外的字段。在文档之后,我让它为"/posts"或"/pages"工作,但我不知道如何为"/media"端点添加字段。

因此(对于"/posts"或"/pages")这是有效的:

add_action( 'rest_api_init', 'np_register_extra_field' );
function np_register_extra_field() {
    register_rest_field( 'post',
    // register_rest_field( 'page', // this works too
        'extra_media_field',
        array(
          'get_callback'    => 'np_get_extra_field',
          'update_callback' => null,
          'schema'          => null,
        )
    );
}
function np_get_extra_field( $object, $field_name, $request ) {
    return 'foobar';
}

对于媒体来说,这不起作用,到目前为止我已经尝试过了:

  add_action( 'rest_api_init', 'np_register_extra_field' );
  function np_register_extra_field() {
      register_rest_field( 'media',
          'extra_media_field',
          array(
              'get_callback'    => 'np_get_extra_field',
              'update_callback' => null,
              'schema'          => null,
          )
      );
  }
  function np_get_extra_field( $object, $field_name, $request ) {
    return 'foobar';
  }

我还尝试过"挂钩"其他过滤器(这是正确的说法吗?)

add_action( 'rest_media_query', 'np_register_extra_field' );
add_action( 'rest_pre_insert_media', 'np_register_extra_field' );
add_action( 'rest_prepare_attachment', 'np_register_extra_field' );

这些似乎都无济于事。

最终目标是将字段"srcset"添加到媒体响应

使用

wp-json-api:版本2.0-beta12

wordrpess:版本4.4.2

如有任何帮助,我们将不胜感激。

您需要使用类型attachment而不是media。这应该有效:

  add_action( 'rest_api_init', 'np_register_extra_field' );
  function np_register_extra_field() {
      register_rest_field( 'attachment',
          'extra_media_field',
          array(
              'get_callback'    => 'np_get_extra_field',
              'update_callback' => null,
              'schema'          => null,
          )
      );
  }
  function np_get_extra_field( $object, $field_name, $request ) {
    return 'foobar';
  }