[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Blocks API: WP_Block_Editor_Context class
   4   *
   5   * @package WordPress
   6   * @since 5.8.0
   7   */
   8  
   9  /**
  10   * Contains information about a block editor being rendered.
  11   *
  12   * @since 5.8.0
  13   */
  14  final class WP_Block_Editor_Context {
  15      /**
  16       * String that identifies the block editor being rendered. Can be one of:
  17       *
  18       * - `'core/edit-post'`         - The post editor at `/wp-admin/edit.php`.
  19       * - `'core/edit-widgets'`      - The widgets editor at `/wp-admin/widgets.php`.
  20       * - `'core/customize-widgets'` - The widgets editor at `/wp-admin/customize.php`.
  21       * - `'core/edit-site'`         - The site editor at `/wp-admin/site-editor.php`.
  22       *
  23       * Defaults to 'core/edit-post'.
  24       *
  25       * @since 6.0.0
  26       *
  27       * @var string
  28       */
  29      public $name = 'core/edit-post';
  30  
  31      /**
  32       * The post being edited by the block editor. Optional.
  33       *
  34       * @since 5.8.0
  35       *
  36       * @var WP_Post|null
  37       */
  38      public $post = null;
  39  
  40      /**
  41       * Constructor.
  42       *
  43       * Populates optional properties for a given block editor context.
  44       *
  45       * @since 5.8.0
  46       *
  47       * @param array $settings The list of optional settings to expose in a given context.
  48       */
  49  	public function __construct( array $settings = array() ) {
  50          if ( isset( $settings['name'] ) ) {
  51              $this->name = $settings['name'];
  52          }
  53          if ( isset( $settings['post'] ) ) {
  54              $this->post = $settings['post'];
  55          }
  56      }
  57  }