wp/wp-includes/class-wp-block-editor-context.php
changeset 19 3d72ae0968f4
parent 18 be944660c56a
child 21 48c4eec2b7e6
--- a/wp/wp-includes/class-wp-block-editor-context.php	Wed Sep 21 18:19:35 2022 +0200
+++ b/wp/wp-includes/class-wp-block-editor-context.php	Tue Sep 27 16:37:53 2022 +0200
@@ -7,17 +7,29 @@
  */
 
 /**
- * Class representing a current block editor context.
- *
- * The expectation is that block editor can have a different set
- * of requirements on every screen where it is used. This class
- * allows to define supporting settings that can be used with filters.
+ * Contains information about a block editor being rendered.
  *
  * @since 5.8.0
  */
 final class WP_Block_Editor_Context {
 	/**
-	 * Post being edited. Optional.
+	 * String that identifies the block editor being rendered. Can be one of:
+	 *
+	 * - `'core/edit-post'`         - The post editor at `/wp-admin/edit.php`.
+	 * - `'core/edit-widgets'`      - The widgets editor at `/wp-admin/widgets.php`.
+	 * - `'core/customize-widgets'` - The widgets editor at `/wp-admin/customize.php`.
+	 * - `'core/edit-site'`         - The site editor at `/wp-admin/site-editor.php`.
+	 *
+	 * Defaults to 'core/edit-post'.
+	 *
+	 * @since 6.0.0
+	 *
+	 * @var string
+	 */
+	public $name = 'core/edit-post';
+
+	/**
+	 * The post being edited by the block editor. Optional.
 	 *
 	 * @since 5.8.0
 	 *
@@ -35,6 +47,9 @@
 	 * @param array $settings The list of optional settings to expose in a given context.
 	 */
 	public function __construct( array $settings = array() ) {
+		if ( isset( $settings['name'] ) ) {
+			$this->name = $settings['name'];
+		}
 		if ( isset( $settings['post'] ) ) {
 			$this->post = $settings['post'];
 		}