Skip to content

Docs: Correct type for WP_Screen screen settings.#12653

Draft
ArkaPrabhaChowdhury wants to merge 1 commit into
WordPress:trunkfrom
ArkaPrabhaChowdhury:trac-56607-wp-screen-docs
Draft

Docs: Correct type for WP_Screen screen settings.#12653
ArkaPrabhaChowdhury wants to merge 1 commit into
WordPress:trunkfrom
ArkaPrabhaChowdhury:trac-56607-wp-screen-docs

Conversation

@ArkaPrabhaChowdhury

Copy link
Copy Markdown

Trac ticket: https://core.trac.wordpress.org/ticket/56607

Summary

  • Correct the documented type of WP_Screen::$_screen_settings.
  • Account for the property being null until show_screen_options() initializes it.

The ticket's other proposed type changes have already been addressed by later commits or are no longer applicable to current trunk.

Testing

  • php -l src/wp-admin/includes/class-wp-screen.php
  • phpcbf --standard=phpcs.xml.dist src/wp-admin/includes/class-wp-screen.php
  • phpcs --standard=phpcs.xml.dist src/wp-admin/includes/class-wp-screen.php

Copilot AI review requested due to automatic review settings July 23, 2026 07:22

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates the WP_Admin WP_Screen documentation to accurately reflect that $_screen_settings is not populated until show_screen_options() runs, aligning the property’s PHPDoc with its lifecycle in the class.

Changes:

  • Corrected the PHPDoc type for WP_Screen::$_screen_settings from string to string|null to reflect its initial null state prior to initialization.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions

Copy link
Copy Markdown

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants