<?php

/**

 * Screen API: WP_Screen class

 *

 * @package WordPress

 * @subpackage Administration

 * @since 4.4.0

 */

/**

 * Core class used to implement an admin screen API.

 *

 * @since 3.3.0

 */

final class WP_Screen {

	/**

	 * Any action associated with the screen. 'add' for *-add.php and *-new.php screens. Empty otherwise.

	 *

	 * @since 3.3.0

	 * @var string

	 */

	public $action;

	/**

	 * The base type of the screen. This is typically the same as $id but with any post types and taxonomies stripped.

	 * For example, for an $id of 'edit-post' the base is 'edit'.

	 *

	 * @since 3.3.0

	 * @var string

	 */

	public $base;

	/**

	 * The number of columns to display. Access with get_columns().

	 *

	 * @since 3.4.0

	 * @var int

	 */

	private $columns = 0;

	/**

	 * The unique ID of the screen.

	 *

	 * @since 3.3.0

	 * @var string

	 */

	public $id;

	/**

	 * Which admin the screen is in. network | user | site | false

	 *

	 * @since 3.5.0

	 * @var string

	 */

	protected $in_admin;

	/**

	 * Whether the screen is in the network admin.

	 *

	 * Deprecated. Use in_admin() instead.

	 *

	 * @since 3.3.0

	 * @deprecated 3.5.0

	 * @var bool

	 */

	public $is_network;

	/**

	 * Whether the screen is in the user admin.

	 *

	 * Deprecated. Use in_admin() instead.

	 *

	 * @since 3.3.0

	 * @deprecated 3.5.0

	 * @var bool

	 */

	public $is_user;

	/**

	 * The base menu parent.

	 * This is derived from $parent_file by removing the query string and any .php extension.

	 * $parent_file values of 'edit.php?post_type=page' and 'edit.php?post_type=post' have a $parent_base of 'edit'.

	 *

	 * @since 3.3.0

	 * @var string

	 */

	public $parent_base;

	/**

	 * The parent_file for the screen per the admin menu system.

	 * Some $parent_file values are 'edit.php?post_type=page', 'edit.php', and 'options-general.php'.

	 *

	 * @since 3.3.0

	 * @var string

	 */

	public $parent_file;

	/**

	 * The post type associated with the screen, if any.

	 * The 'edit.php?post_type=page' screen has a post type of 'page'.

	 * The 'edit-tags.php?taxonomy=$taxonomy&post_type=page' screen has a post type of 'page'.

	 *

	 * @since 3.3.0

	 * @var string

	 */

	public $post_type;

	/**

	 * The taxonomy associated with the screen, if any.

	 * The 'edit-tags.php?taxonomy=category' screen has a taxonomy of 'category'.

	 *

	 * @since 3.3.0

	 * @var string

	 */

	public $taxonomy;

	/**

	 * The help tab data associated with the screen, if any.

	 *

	 * @since 3.3.0

	 * @var array

	 */

	private $_help_tabs = array();

	/**

	 * The help sidebar data associated with screen, if any.

	 *

	 * @since 3.3.0

	 * @var string

	 */

	private $_help_sidebar = '';

	/**

	 * The accessible hidden headings and text associated with the screen, if any.

	 *

	 * @since 4.4.0

	 * @var array

	 */

	private $_screen_reader_content = array();

	/**

	 * Stores old string-based help.

	 *

	 * @var array

	 */

	private static $_old_compat_help = array();

	/**

	 * The screen options associated with screen, if any.

	 *

	 * @since 3.3.0

	 * @var array

	 */

	private $_options = array();

	/**

	 * The screen object registry.

	 *

	 * @since 3.3.0

	 *

	 * @var array

	 */

	private static $_registry = array();

	/**

	 * Stores the result of the public show_screen_options function.

	 *

	 * @since 3.3.0

	 * @var bool

	 */

	private $_show_screen_options;

	/**

	 * Stores the 'screen_settings' section of screen options.

	 *

	 * @since 3.3.0

	 * @var string

	 */

	private $_screen_settings;

	/**

	 * Whether the screen is using the block editor.

	 *

	 * @since 5.0.0

	 * @var bool

	 */

	public $is_block_editor = false;

	/**

	 * Fetches a screen object.

	 *

	 * @since 3.3.0

	 *

	 * @global string $hook_suffix

	 *

	 * @param string|WP_Screen $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen.

	 *                                    Defaults to the current $hook_suffix global.

	 * @return WP_Screen Screen object.

	 */

	public static function get( $hook_name = '' ) {

		if ( $hook_name instanceof WP_Screen ) {

			return $hook_name;

		}

		$post_type       = $taxonomy = null;

		$in_admin        = false;

		$action          = '';

		$is_block_editor = false;

		if ( $hook_name ) {

			$id = $hook_name;

		} else {

			$id = $GLOBALS['hook_suffix'];

		}

		// For those pesky meta boxes.

		if ( $hook_name && post_type_exists( $hook_name ) ) {

			$post_type = $id;

			$id        = 'post'; // changes later. ends up being $base.

		} else {

			if ( '.php' == substr( $id, -4 ) ) {

				$id = substr( $id, 0, -4 );

			}

			if ( 'post-new' == $id || 'link-add' == $id || 'media-new' == $id || 'user-new' == $id ) {

				$id     = substr( $id, 0, -4 );

				$action = 'add';

			}

		}

		if ( ! $post_type && $hook_name ) {

			if ( '-network' == substr( $id, -8 ) ) {

				$id       = substr( $id, 0, -8 );

				$in_admin = 'network';

			} elseif ( '-user' == substr( $id, -5 ) ) {

				$id       = substr( $id, 0, -5 );

				$in_admin = 'user';

			}

			$id = sanitize_key( $id );

			if ( 'edit-comments' != $id && 'edit-tags' != $id && 'edit-' == substr( $id, 0, 5 ) ) {

				$maybe = substr( $id, 5 );

				if ( taxonomy_exists( $maybe ) ) {

					$id       = 'edit-tags';

					$taxonomy = $maybe;

				} elseif ( post_type_exists( $maybe ) ) {

					$id        = 'edit';

					$post_type = $maybe;

				}

			}

			if ( ! $in_admin ) {

				$in_admin = 'site';

			}

		} else {

			if ( defined( 'WP_NETWORK_ADMIN' ) && WP_NETWORK_ADMIN ) {

				$in_admin = 'network';

			} elseif ( defined( 'WP_USER_ADMIN' ) && WP_USER_ADMIN ) {

				$in_admin = 'user';

			} else {

				$in_admin = 'site';

			}

		}

		if ( 'index' == $id ) {

			$id = 'dashboard';

		} elseif ( 'front' == $id ) {

			$in_admin = false;

		}

		$base = $id;

		// If this is the current screen, see if we can be more accurate for post types and taxonomies.

		if ( ! $hook_name ) {

			if ( isset( $_REQUEST['post_type'] ) ) {

				$post_type = post_type_exists( $_REQUEST['post_type'] ) ? $_REQUEST['post_type'] : false;

			}

			if ( isset( $_REQUEST['taxonomy'] ) ) {

				$taxonomy = taxonomy_exists( $_REQUEST['taxonomy'] ) ? $_REQUEST['taxonomy'] : false;

			}

			switch ( $base ) {

				case 'post':

					if ( isset( $_GET['post'] ) && isset( $_POST['post_ID'] ) && (int) $_GET['post'] !== (int) $_POST['post_ID'] ) {

						wp_die( __( 'A post ID mismatch has been detected.' ), __( 'Sorry, you are not allowed to edit this item.' ), 400 );

					} elseif ( isset( $_GET['post'] ) ) {

						$post_id = (int) $_GET['post'];

					} elseif ( isset( $_POST['post_ID'] ) ) {

						$post_id = (int) $_POST['post_ID'];

					} else {

						$post_id = 0;

					}

					if ( $post_id ) {

						$post = get_post( $post_id );

						if ( $post ) {

							$post_type = $post->post_type;

							/** This filter is documented in wp-admin/post.php */

							$replace_editor = apply_filters( 'replace_editor', false, $post );

							if ( ! $replace_editor ) {

								$is_block_editor = use_block_editor_for_post( $post );

							}

						}

					}

					break;

				case 'edit-tags':

				case 'term':

					if ( null === $post_type && is_object_in_taxonomy( 'post', $taxonomy ? $taxonomy : 'post_tag' ) ) {

						$post_type = 'post';

					}

					break;

				case 'upload':

					$post_type = 'attachment';

					break;

			}

		}

		switch ( $base ) {

			case 'post':

				if ( null === $post_type ) {

					$post_type = 'post';

				}

				// When creating a new post, use the default block editor support value for the post type.

				if ( empty( $post_id ) ) {

					$is_block_editor = use_block_editor_for_post_type( $post_type );

				}

				$id = $post_type;

				break;

			case 'edit':

				if ( null === $post_type ) {

					$post_type = 'post';

				}

				$id .= '-' . $post_type;

				break;

			case 'edit-tags':

			case 'term':

				if ( null === $taxonomy ) {

					$taxonomy = 'post_tag';

				}

				// The edit-tags ID does not contain the post type. Look for it in the request.

				if ( null === $post_type ) {

					$post_type = 'post';

					if ( isset( $_REQUEST['post_type'] ) && post_type_exists( $_REQUEST['post_type'] ) ) {

						$post_type = $_REQUEST['post_type'];

					}

				}

				$id = 'edit-' . $taxonomy;

				break;

		}

		if ( 'network' == $in_admin ) {

			$id   .= '-network';

			$base .= '-network';

		} elseif ( 'user' == $in_admin ) {

			$id   .= '-user';

			$base .= '-user';

		}

		if ( isset( self::$_registry[ $id ] ) ) {

			$screen = self::$_registry[ $id ];

			if ( $screen === get_current_screen() ) {

				return $screen;

			}

		} else {

			$screen     = new WP_Screen();

			$screen->id = $id;

		}

		$screen->base            = $base;

		$screen->action          = $action;

		$screen->post_type       = (string) $post_type;

		$screen->taxonomy        = (string) $taxonomy;

		$screen->is_user         = ( 'user' == $in_admin );

		$screen->is_network      = ( 'network' == $in_admin );

		$screen->in_admin        = $in_admin;

		$screen->is_block_editor = $is_block_editor;

		self::$_registry[ $id ] = $screen;

		return $screen;

	}

	/**

	 * Makes the screen object the current screen.

	 *

	 * @see set_current_screen()

	 * @since 3.3.0

	 *

	 * @global WP_Screen $current_screen

	 * @global string    $taxnow

	 * @global string    $typenow

	 */

	public function set_current_screen() {

		global $current_screen, $taxnow, $typenow;

		$current_screen = $this;

		$taxnow         = $this->taxonomy;

		$typenow        = $this->post_type;

		/**

		 * Fires after the current screen has been set.

		 *

		 * @since 3.0.0

		 *

		 * @param WP_Screen $current_screen Current WP_Screen object.

		 */

		do_action( 'current_screen', $current_screen );

	}

	/**

	 * Constructor

	 *

	 * @since 3.3.0

	 */

	private function __construct() {}

	/**

	 * Indicates whether the screen is in a particular admin

	 *

	 * @since 3.5.0

	 *

	 * @param string $admin The admin to check against (network | user | site).

	 *                      If empty any of the three admins will result in true.

	 * @return bool True if the screen is in the indicated admin, false otherwise.

	 */

	public function in_admin( $admin = null ) {

		if ( empty( $admin ) ) {

			return (bool) $this->in_admin;

		}