Skip to content

Get the formatted_value from the original field value #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 23, 2025
Merged

Get the formatted_value from the original field value #211

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
78e23a7
Get the `formatted_value` from the original field value not the forma…
Mr2P Aug 30, 2025
b2d71af
Get the formatted_value from the original field value
Mr2P Aug 30, 2025
4315633
Lint ternary operator
priethor Sep 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions includes/rest-api/class-acf-rest-api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,11 +231,11 @@ public function load_fields( $object, $field_name, $request, $object_sub_type )
}

// Format the field value according to the request params.
$format = $request->get_param( 'acf_format' ) ?: acf_get_setting( 'rest_api_format' );
$value = acf_format_value_for_rest( $value, $post_id, $field, $format );
$format = $request->get_param( 'acf_format' ) ? $request->get_param( 'acf_format' ) : acf_get_setting( 'rest_api_format' );
$rest_value = acf_format_value_for_rest( $value, $post_id, $field, $format );

// We keep this one for backward compatibility with existing code that expects the field value to be.
$fields[ $field['name'] ] = $value;
$fields[ $field['name'] ] = $rest_value;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution!

Why will this fix your fatal error on the plugin? The change, as far as I can see, is just changing a variable name.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thanks for approving the pull request.
Here is my explanation.

The original code from SCF:

// Get raw value.
$value = acf_get_value( $post_id, $field );

// First format for rest API for backward compatibility.
$value = acf_format_value_for_rest( $value, $post_id, $field, $format );

// We keep this one for backward compatibility with existing code that expects the field value to be.
$fields[ $field['name'] ] = $value;
$fields[ $field['name'] . '_source' ] = array(
'label' => $field['label'],
'type' => $field['type'],
// This line re-formats the already formatted REST value instead of the raw value, which causes issues.
'formatted_value' => acf_format_value( $value, $post_id, $field ),
);

I fixed it by renaming the formatted REST value to $rest_value and leaving the original $value untouched. This way, when calling acf_format_value() to populate the formatted_value property of _source, it’s based on the raw value, not on the already formatted value:

// Format value for rest API for backward compatibility.
$rest_value = acf_format_value_for_rest( $value, $post_id, $field, $format );

// We keep this one for backward compatibility with existing code that expects the field value to be.
$fields[ $field['name'] ] = $rest_value;
$fields[ $field['name'] . '_source' ] = array(
'label' => $field['label'],
'type' => $field['type'],
'formatted_value' => acf_format_value( $value, $post_id, $field ),
);

In my plugin (Meta Field Block), I used the 'acf/rest/format_value_for_rest' filter to change the format of the REST value to support displaying all field types (even Group, Repeater, Flexible, Relationship, etc). When SCF re-format some multi-value field types like select, it treats the altered REST value as multiple values, which is why the error occurs.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Mr2P, thanks again for engaging here 🙂

After a thorough read of the full method, I agree that the new variable name is helping not to overwrite the existing $value variable, great! My only concern is that I am not sure about the side effects this effect can have for other users; would you mind adding some tests to ensure backwards compatibility?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @priethor,

I’m not sure what needs to be tested for this fix. The root cause of the issue is that, starting with SCF 6.5.2, the wrong value has been assigned to the new formatted_value property.

It should be:

$raw_value = acf_get_value( $post_id, $field );
$fields[ $field['name'] . '_source' ] = array(
'formatted_value' => acf_format_value( $raw_value, $post_id, $field ),
);

not:

$raw_value = acf_get_value( $post_id, $field );
$formatted_value_for_rest = acf_format_value_for_rest( $raw_value, $post_id, $field, $format );
$fields[ $field['name'] . '_source' ] = array(
'formatted_value' => acf_format_value( $formatted_value_for_rest, $post_id, $field ),
);

The value returned by acf_format_value_for_rest is filtered by:

apply_filters( 'acf/rest/format_value_for_rest', $value_formatted, $post_id, $field, $value, $format );

If any third-party plugin uses this filter to change the REST value, the formatted_value property may end up with the wrong value.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha! From a logical point of view, it makes sense to me to run the formatting on the raw value instead of the already-formatted-for-REST value, especially considering you can hook into the latter.

I'm going to go ahead and proceed, but I'd still love it if @cbravobernal of @ockham could verify that there are no side effects in block bindings, as the formatted_value property, even if introduced in 6.5.2, is used there.

Thanks for bearing with us, @Mr2P, and please keep the feedback and testing coming ❤️

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@priethor Thanks for the approving. I'll keep testing on my end.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are no side effects on block bindings. As far as I tested. Let's merge it.

$fields[ $field['name'] . '_source' ] = array(
'label' => $field['label'],
'type' => $field['type'],
Expand Down
Loading