class GutenbergPlugin in Gutenberg 8

Defines a GutenbergPlugin annotation object.

Plugin Namespace: Plugin\GutenbergPlugin.

For a working example, see \Drupal\gutenberg\Plugin\GutenbergPlugin\DrupalImage

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\gutenberg\Annotation\GutenbergPlugin

See also

\Drupal\gutenberg\GutenbergPluginManager

hook_gutenberg_plugin_info_alter()

Plugin API

1 class is annotated with GutenbergPlugin

DrupalImage in src/Plugin/GutenbergPlugin/DrupalImage.php

Defines the "drupalimage" plugin.

File

src/Annotation/GutenbergPlugin.php, line 21

Namespace

Drupal\gutenberg\Annotation

class GutenbergPlugin extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the Gutenberg plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

}

Members

Name	Modifiers	Type	Description	Overrides
GutenbergPlugin::$id	public	property	The plugin ID.
GutenbergPlugin::$label	public	property	The human-readable name of the Gutenberg plugin.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2