¿Existe una función como is_rest() en WordPress para detectar peticiones API REST?

Acabo de toparme con el mismo problema y escribí una función simple is_rest que te permite verificar si la solicitud actual es una solicitud de la API REST de WordPress.

<?php

if ( !function_exists( 'is_rest' ) ) {
    /**
     * Verifica si la solicitud actual es una solicitud de la API REST de WordPress.
     *
     * Caso #1: Después de la inicialización de WP_REST_Request
     * Caso #2: Soporte para ajustes de enlaces permanentes "simples" y verifica si `rest_route` comienza con `/`
     * Caso #3: Puede ocurrir que WP_Rewrite no esté inicializado aún,
     *          así que haz esto (wp-settings.php)
     * Caso #4: La ruta URL comienza con wp-json/ (tu prefijo REST)
     *          También soporta instalaciones de WP en subcarpetas
     *
     * @returns boolean
     * @author matzeeable
     */
    function is_rest() {
        if (defined('REST_REQUEST') && REST_REQUEST // (#1)
                || isset($_GET['rest_route']) // (#2)
                        && strpos( $_GET['rest_route'], '/', 0 ) === 0)
                return true;

        // (#3)
        global $wp_rewrite;
        if ($wp_rewrite === null) $wp_rewrite = new WP_Rewrite();
            
        // (#4)
        $rest_url = wp_parse_url( trailingslashit( rest_url( ) ) );
        $current_url = wp_parse_url( add_query_arg( array( ) ) );
        return strpos( $current_url['path'] ?? '/', $rest_url['path'], 0 ) === 0;
    }
}

Referencias:

• https://gist.github.com/matzeeable/dfd82239f48c2fedef25141e48c8dc30
• https://twitter.com/matzeeable/status/1052967482737258496

Si lo necesitas después de que se haya ejecutado init:

defined('REST_REQUEST') && REST_REQUEST

Si lo necesitas antes de init, hay dos formas:

Usar wp_is_json_request() (Introducido en WordPress 5.0), o intentar inferir si es una solicitud REST a través de la URL. Detectar la URL variará si el sitio usa enlaces permanentes o enlaces permanentes simples.

WooCommerce lo hace así, y es una buena solución:

function is_rest_api_request() {
    if ( empty( $_SERVER['REQUEST_URI'] ) ) {
        // Probablemente una solicitud CLI
        return false;
    }

    $rest_prefix         = trailingslashit( rest_get_url_prefix() );
    $is_rest_api_request = strpos( $_SERVER['REQUEST_URI'], $rest_prefix ) !== false;

    return apply_filters( 'is_rest_api_request', $is_rest_api_request );
}

Aquí tienes realmente dos opciones,

1. Verificar si REST_REQUEST está definido.
2. Enganchar a rest_api_init donde querías enganchar a init.

Para resolver este problema escribí una función personalizada simple basada en la suposición de que si la URI solicitada cae bajo la URL de la API Rest del sitio WordPress, entonces es una solicitud de la API Rest.

Si es un endpoint válido o está autenticado, no es responsabilidad de esta función determinarlo. La pregunta es esta: ¿la URL es una URL potencial de la API Rest?

function isRestUrl() {
    $bIsRest = false;
    if ( function_exists( 'rest_url' ) && !empty( $_SERVER[ 'REQUEST_URI' ] ) ) {
        $sRestUrlBase = get_rest_url( get_current_blog_id(), '/' );
        $sRestPath = trim( parse_url( $sRestUrlBase, PHP_URL_PATH ), '/' );
        $sRequestPath = trim( $_SERVER[ 'REQUEST_URI' ], '/' );
        $bIsRest = ( strpos( $sRequestPath, $sRestPath ) === 0 );
    }
    return $bIsRest;
}

Si tu $_SERVER['REQUEST_URI'] no está correctamente poblado, esta función seguirá devolviendo false, independientemente.

No hay codificación fija de la URL, por lo que si por alguna razón cambias la URL base de tu API, esta se adaptará.

Puede que no sea lo correcto, pero terminé con

if (strpos($_SERVER[ 'REQUEST_URI' ], '/wp-json/') !== false) {
    // Cosas interesantes de la API aquí
}

No dudes en hacerme saber si esto no es correcto. Estoy intentando crear un plugin inicial útil para compartir eventualmente: https://gitlab.com/ripp.io/wordpress/plugin-starter

Con WordPress 6.5, el núcleo proporciona una función wp_is_rest_endpoint para determinar de manera confiable si la solicitud actual es una solicitud dirigida a un endpoint REST.

También existe otra función wp_is_serving_rest_request para verificar si realmente se está atendiendo una solicitud de la API REST. Si la utilizas, asegúrate de llamarla después de la acción parse_request, ya que siempre devolverá false antes de eso.

Puedes usar wp_is_json_request() como se muestra a continuación:

if ( wp_is_json_request() ) {
    // haz lo que necesites aquí
}

Asegúrate de configurar Accepts o Content-Type como application/json de lo contrario wp_is_json_request() devolverá false.

Más documentación: https://developer.wordpress.org/reference/functions/wp_is_json_request/