Docs: Add missing description for $current_screen global.

SergeyBiryukov · SergeyBiryukov · commit a7b20de9588e · 2019-08-04T02:02:10.000Z
Props mukesh27. Fixes #45604. See #47110. git-svn-id: https://develop.svn.wordpress.org/trunk@45740 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-admin/admin-header.php b/src/wp-admin/admin-header.php
@@ -16,7 +16,7 @@
  *
  * @global string    $title
  * @global string    $hook_suffix
- * @global WP_Screen $current_screen
+ * @global WP_Screen $current_screen     WordPress current screen object.
  * @global WP_Locale $wp_locale          WordPress date and time locale object.
  * @global string    $pagenow
  * @global string    $update_title
diff --git a/src/wp-admin/includes/class-wp-screen.php b/src/wp-admin/includes/class-wp-screen.php
@@ -392,7 +392,7 @@ public static function get( $hook_name = '' ) {
 	 * @see set_current_screen()
 	 * @since 3.3.0
 	 *
-	 * @global WP_Screen $current_screen
+	 * @global WP_Screen $current_screen WordPress current screen object.
 	 * @global string    $taxnow
 	 * @global string    $typenow
 	 */
diff --git a/src/wp-admin/includes/screen.php b/src/wp-admin/includes/screen.php
@@ -215,7 +215,7 @@ function add_screen_option( $option, $args = array() ) {
  *
  * @since 3.1.0
  *
- * @global WP_Screen $current_screen
+ * @global WP_Screen $current_screen WordPress current screen object.
  *
  * @return WP_Screen|null Current screen object or null when screen not defined.
  */
diff --git a/src/wp-includes/load.php b/src/wp-includes/load.php
@@ -985,7 +985,7 @@ function wp_clone( $object ) {
  *
  * @since 1.5.1
  *
- * @global WP_Screen $current_screen
+ * @global WP_Screen $current_screen WordPress current screen object.
  *
  * @return bool True if inside WordPress administration interface, false otherwise.
  */
@@ -1009,7 +1009,7 @@ function is_admin() {
  *
  * @since 3.1.0
  *
- * @global WP_Screen $current_screen
+ * @global WP_Screen $current_screen WordPress current screen object.
  *
  * @return bool True if inside WordPress blog administration pages.
  */
@@ -1036,7 +1036,7 @@ function is_blog_admin() {
  *
  * @since 3.1.0
  *
- * @global WP_Screen $current_screen
+ * @global WP_Screen $current_screen WordPress current screen object.
  *
  * @return bool True if inside WordPress network administration pages.
  */
@@ -1060,7 +1060,7 @@ function is_network_admin() {
  *
  * @since 3.1.0
  *
- * @global WP_Screen $current_screen
+ * @global WP_Screen $current_screen WordPress current screen object.
  *
  * @return bool True if inside WordPress user administration pages.
  */
diff --git a/src/wp-includes/script-loader.php b/src/wp-includes/script-loader.php
@@ -2708,7 +2708,7 @@ function script_concat_settings() {
  *
  * @since 5.0.0
  *
- * @global WP_Screen $current_screen
+ * @global WP_Screen $current_screen WordPress current screen object.
  */
 function wp_common_block_scripts_and_styles() {
 	global $current_screen;
@@ -2742,7 +2742,7 @@ function wp_common_block_scripts_and_styles() {
  *
  * @since 5.0.0
  *
- * @global WP_Screen $current_screen
+ * @global WP_Screen $current_screen WordPress current screen object.
  */
 function wp_enqueue_registered_block_scripts_and_styles() {
 	global $current_screen;

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`*`
`17`	`17`	`* @global string $title`
`18`	`18`	`* @global string $hook_suffix`
`19`		`- * @global WP_Screen $current_screen`
	`19`	`+ * @global WP_Screen $current_screen WordPress current screen object.`
`20`	`20`	`* @global WP_Locale $wp_locale WordPress date and time locale object.`
`21`	`21`	`* @global string $pagenow`
`22`	`22`	`* @global string $update_title`
Original file line number	Diff line number	Diff line change
`@@ -392,7 +392,7 @@ public static function get( $hook_name = '' ) {`
`392`	`392`	`* @see set_current_screen()`
`393`	`393`	`* @since 3.3.0`
`394`	`394`	`*`
`395`		`- * @global WP_Screen $current_screen`
	`395`	`+ * @global WP_Screen $current_screen WordPress current screen object.`
`396`	`396`	`* @global string $taxnow`
`397`	`397`	`* @global string $typenow`
`398`	`398`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -215,7 +215,7 @@ function add_screen_option( $option, $args = array() ) {`
`215`	`215`	`*`
`216`	`216`	`* @since 3.1.0`
`217`	`217`	`*`
`218`		`- * @global WP_Screen $current_screen`
	`218`	`+ * @global WP_Screen $current_screen WordPress current screen object.`
`219`	`219`	`*`
`220`	`220`	`* @return WP_Screen\|null Current screen object or null when screen not defined.`
`221`	`221`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -985,7 +985,7 @@ function wp_clone( $object ) {`
`985`	`985`	`*`
`986`	`986`	`* @since 1.5.1`
`987`	`987`	`*`
`988`		`- * @global WP_Screen $current_screen`
	`988`	`+ * @global WP_Screen $current_screen WordPress current screen object.`
`989`	`989`	`*`
`990`	`990`	`* @return bool True if inside WordPress administration interface, false otherwise.`
`991`	`991`	`*/`
`@@ -1009,7 +1009,7 @@ function is_admin() {`
`1009`	`1009`	`*`
`1010`	`1010`	`* @since 3.1.0`
`1011`	`1011`	`*`
`1012`		`- * @global WP_Screen $current_screen`
	`1012`	`+ * @global WP_Screen $current_screen WordPress current screen object.`
`1013`	`1013`	`*`
`1014`	`1014`	`* @return bool True if inside WordPress blog administration pages.`
`1015`	`1015`	`*/`
`@@ -1036,7 +1036,7 @@ function is_blog_admin() {`
`1036`	`1036`	`*`
`1037`	`1037`	`* @since 3.1.0`
`1038`	`1038`	`*`
`1039`		`- * @global WP_Screen $current_screen`
	`1039`	`+ * @global WP_Screen $current_screen WordPress current screen object.`
`1040`	`1040`	`*`
`1041`	`1041`	`* @return bool True if inside WordPress network administration pages.`
`1042`	`1042`	`*/`
`@@ -1060,7 +1060,7 @@ function is_network_admin() {`
`1060`	`1060`	`*`
`1061`	`1061`	`* @since 3.1.0`
`1062`	`1062`	`*`
`1063`		`- * @global WP_Screen $current_screen`
	`1063`	`+ * @global WP_Screen $current_screen WordPress current screen object.`
`1064`	`1064`	`*`
`1065`	`1065`	`* @return bool True if inside WordPress user administration pages.`
`1066`	`1066`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -2708,7 +2708,7 @@ function script_concat_settings() {`
`2708`	`2708`	`*`
`2709`	`2709`	`* @since 5.0.0`
`2710`	`2710`	`*`
`2711`		`- * @global WP_Screen $current_screen`
	`2711`	`+ * @global WP_Screen $current_screen WordPress current screen object.`
`2712`	`2712`	`*/`
`2713`	`2713`	`function wp_common_block_scripts_and_styles() {`
`2714`	`2714`	`global $current_screen;`
`@@ -2742,7 +2742,7 @@ function wp_common_block_scripts_and_styles() {`
`2742`	`2742`	`*`
`2743`	`2743`	`* @since 5.0.0`
`2744`	`2744`	`*`
`2745`		`- * @global WP_Screen $current_screen`
	`2745`	`+ * @global WP_Screen $current_screen WordPress current screen object.`
`2746`	`2746`	`*/`
`2747`	`2747`	`function wp_enqueue_registered_block_scripts_and_styles() {`
`2748`	`2748`	`global $current_screen;`