Block Editor: Add an `is_block_editor()` method to `WP_Screen`.

This method allows checking (or setting) whether the block editor is loading on the current screen.

Merges [43777] from the 5.0 branch to trunk.

See #45037.


git-svn-id: https://develop.svn.wordpress.org/trunk@44130 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Gary Pendergast 2018-12-14 01:07:11 +00:00
parent 8a54057af7
commit 99dd4f8c38
1 changed files with 24 additions and 0 deletions

View File

@ -178,6 +178,14 @@ final class WP_Screen {
*/ */
private $_screen_settings; 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. * Fetches a screen object.
* *
@ -412,6 +420,22 @@ final class WP_Screen {
return ( $admin == $this->in_admin ); return ( $admin == $this->in_admin );
} }
/**
* Sets or returns whether the block editor is loading on the current screen.
*
* @since 5.0.0
*
* @param bool $set Optional. Sets whether the block editor is loading on the current screen or not.
* @return bool True if the block editor is being loaded, false otherwise.
*/
public function is_block_editor( $set = null ) {
if ( $set !== null ) {
$this->is_block_editor = (bool) $set;
}
return $this->is_block_editor;
}
/** /**
* Sets the old string-based contextual help for the screen for backward compatibility. * Sets the old string-based contextual help for the screen for backward compatibility.
* *