Skip to content

Image: Fix return type annotation for lightbox settings function #71073

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.

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

Conversation

himanshupathak95
Copy link
Contributor

@himanshupathak95 himanshupathak95 commented Aug 5, 2025

What?

Updates the @return annotation for block_core_image_get_lightbox_settings() to accurately reflect that the function can return null.

Why?

The function's DocBlock incorrectly documented the return type as only array, but the actual implementation can return null when lightbox settings are not found.


Originally opened on Trac as Core-63790

@himanshupathak95 himanshupathak95 marked this pull request as ready for review August 5, 2025 22:22
Copy link

github-actions bot commented Aug 5, 2025

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: himanshupathak95 <abcd95@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@westonruter westonruter added [Type] Developer Documentation Documentation for developers [Block] Image Affects the Image Block labels Aug 5, 2025
@westonruter westonruter added this to the Gutenberg 21.4 milestone Aug 5, 2025
@westonruter westonruter merged commit cbd7616 into WordPress:trunk Aug 5, 2025
67 of 69 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Image Affects the Image Block [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants