2.x Update Timber\Post::get_info() to work with a post data array only

[gchtr]

Resolves:

• Fatal Error when previewing posts with images with PHP 8.0+ #2582

Issue

The different usages of Timber\Post::get_info() are not implemented consistently. Sometimes it’s implemented with an array as the parameter an other times with a WP_Post instance.

Solution

This pull request changes the function signature of Timber\Post::get_info() to accept an array and return an array. The related WP_Post object is converted to an array before being passed to Timber\Post::get_info(). This way, we don’t set properties on a WP_Post, but update the array. This array will then be used to import properties to the Timber\Post instance.

I also moved a test related to previews to the corresponding test class.

This will also fix a related issue in #2668 where PHPStan warns about setting undefined properties on a post.

Impact

If you use a custom get_info() method in a class that extends Timber\Post, you would have to update your code. This is documented in the Upgrade Guide.

Usage Changes

See Impact.

Considerations

Maybe there’s a better solution than using arrays only. It will fix PHPStan issues, but it’s not really preventing us from setting undefined properties.

Testing

Yes.

[nlemoine]

I agree with your considerations. But it works in the meantime 🙈

[gchtr]

@nlemoine Thanks for the feedback 👍. I opened a new issue in #2704 where we can think about a better solution for this. I think we could do this more: Merge in pull requests if they work for the moment and create new issues where we can decide whether it needs to be fixed immediately or sometime in the future.

I will merge this in now, because the tests are fine (except for the tests with PHP 8.2).

[andrewwfesenko]

@gchtr The introduction of these changes seems to have broken the post previewing:

Previously it worked fine.

[gchtr]

@andrewwfesenko What version of Timber v2 are you using? The latest 2.x branch?

[andrewwfesenko]

@gchtr Yes. Latest 2.x, 34f29b8 commit to be exact.

[gchtr]

@andrewwfesenko Can you create a new issue with a minimal setup so we can reproduce this? Because I can’t reproduce that bug (yet).