Block: Privatize and improve the API for getting the block image

[t-hamano]

#68910 added an API for showing images of the block in list view. For now, we should turn it into a private API and improve it if necessary.

See:

• Package blocks: Introduce a utility for getting the block image #68910 (comment)
• Package blocks: Introduce a utility for getting the block image #68910 (comment)
• Package blocks: Introduce a utility for getting the block image #68910 (review)

[fabiankaegy]

@t-hamano @Mamaduka thanks for your insights and help here :)

From my POV it would be very beneficial to have a public API for providing an image to be used in places like the list view etc. It is a capability that core blocks have, so 3rd party blocks should also be able to use it.

As far as the internal functions go sure we can make all of that private though :)

[Mamaduka]

From my POV it would be very beneficial to have a public API for providing an image to be used in places like the list view etc. It is a capability that core blocks have, so 3rd party blocks should also be able to use it.

I agree; I think it could be a helpful API for third-party blocks. I even have one that could use it 😄

My current concerns

• The new method name is too generic. An image method for what?
• Maybe we're rushing the API.

My plan

• Reverts part of the Package blocks: Introduce a utility for getting the block image #68910.
• Keep implementation internal for all core blocks for now.
• Create a proposal for a new API and share it with the core team.

What do you think?

[fabiankaegy]

That works for me :)

I will say though, that to me we kind of already are at that spot. We did the experiment with just a hardcoded solution for the image clock. Then expanded it to the gallery. And now with the last PR decided it would make sense to add it to the cover, media text etc.

To me that indicates a need for an API to handle this and also shows that there is demand for more broad usage :)

[Mamaduka]

The problem with the public APIs is that they're easy to add, but almost impossible to remove. We'll have to maintain it "forever". That's why I want to be cautious.