Image Format in Rest API is always ID

• shortee

• February 25, 2022 at 10:03 am

Updated to 5.9.1 and now all images are only output as ID even though it is set to be URLs.

• dev-plural

• February 26, 2022 at 6:44 am

Hey, I’ve got the same issue. As it breaks my clients site completely, it’s quite urgent.

Thanks for having a look,
Tobi

• dev-plural

• February 27, 2022 at 1:30 pm

Hey @shortee, I just found a thread from late 2021 which explains the fix for this:
https://support.advancedcustomfields.com/forums/topic/acf-rest-api-image-only-shows-attachment-id/

Add ?acf_format=standard to your API call. Hope that fixed your issue too.

Cheers,
Tobi

• shortee

• March 1, 2022 at 3:43 am

thx a lot @dev-plural. this also solved my problem.

• poncho

• March 9, 2022 at 4:47 pm

Very interesting. This also solves my problem, but as the return value for all fields change it creates new problems with other fields.

Is it possible to change the output format for a single field?

• Zek

• April 1, 2023 at 1:10 pm

Another solution is to use acf/rest/format_value_for_rest/type=image filter

function custom_acf_rest_api_image_format($value, $post_id, $field) {
    // Get the full image object from the ID using wp_get_attachment_image_src()
    $image = wp_get_attachment_image_src($value, 'full');
    // Return an array with the image URL and other metadata
    return array(
        'url' => $image[0],
        'width' => $image[1],
        'height' => $image[2],
        'alt' => get_post_meta($value, '_wp_attachment_image_alt', true)
    );
}

// Hook the filter function to the acf/rest/format_value_for_rest/type=image filter
add_filter('acf/rest/format_value_for_rest/type=image', 'custom_acf_rest_api_image_format', 10, 3);