Changeset 61300

Timestamp:

11/25/2025 02:18:04 AM (3 months ago)

Author:

westonruter

Message:

Docs: Improve docblocks and types for WP_Screen properties.

• Correctly hint that WP_Screen::$_show_screen_options is null before being instantiated.
• Correctly hint that ::get_option(), get_help_tab() and get_screen_reader_text() can return null.
• Ensure $this->columns is an int, by casting $this->get_option( 'layout_columns', 'default' ) from its numeric string.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/8860

Props justlevine, peterwilsoncc, westonruter.
See #64238, #64224.

File:

• trunk/src/wp-admin/includes/class-wp-screen.php (modified) (5 diffs)

trunk/src/wp-admin/includes/class-wp-screen.php

@@ -176 +176 @@
      * Stores the result of the public show_screen_options function.
      *
-     * @since 3.3.0
-     * @var bool
+     * Set when calling {@see self::show_screen_options()} for the first time.
+     *
+     * @since 3.3.0
+     * @var ?bool
      */
     private $_show_screen_options;
@@ -546 +548 @@
      * @param string|false $key    Optional. Specific array key for when the option is an array.
      *                             Default false.
-     * @return string The option value if set, null otherwise.
+     * @return ?string The option value if set, null otherwise.
      */
     public function get_option( $option, $key = false ) {
@@ -599 +601 @@
      *
      * @param string $id Help Tab ID.
-     * @return array Help tab arguments.
+     * @return ?array Help tab arguments, or null if no help tabs added.
      */
     public function get_help_tab( $id ) {
@@ -734 +736 @@
      *
      * @param string $key Screen reader text array named key.
-     * @return string Screen reader text string.
+     * @return ?string Screen reader text string, or null if no text is associated with the key.
      */
     public function get_screen_reader_text( $key ) {
@@ -950 +952 @@
             $this->columns = (int) get_user_option( "screen_layout_$this->id" );
 
-            if ( ! $this->columns && $this->get_option( 'layout_columns', 'default' ) ) {
-                $this->columns = $this->get_option( 'layout_columns', 'default' );
+            $layout_columns = (int) $this->get_option( 'layout_columns', 'default' );
+            if ( ! $this->columns && $layout_columns ) {
+                $this->columns = $layout_columns;
             }
         }