class CKEditorPlugin

Same name and namespace in other branches
  1. 8.9.x core/modules/ckeditor/src/Annotation/CKEditorPlugin.php \Drupal\ckeditor\Annotation\CKEditorPlugin

Defines a CKEditorPlugin annotation object.

Plugin Namespace: Plugin\CKEditorPlugin

For a working example, see \Drupal\ckeditor\Plugin\CKEditorPlugin\DrupalImage

Hierarchy

Expanded class hierarchy of CKEditorPlugin

See also

\Drupal\ckeditor\CKEditorPluginInterface

\Drupal\ckeditor\CKEditorPluginBase

\Drupal\ckeditor\CKEditorPluginManager

hook_ckeditor_plugin_info_alter()

Plugin API

Related topics

Annotations
Annotations for class discovery and metadata description.
11 classes are annotated with CKEditorPlugin
DrupalImage in core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalImage.php
Defines the "drupalimage" plugin.
DrupalImageCaption in core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalImageCaption.php
Defines the "drupalimagecaption" plugin.
DrupalLink in core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalLink.php
Defines the "drupallink" plugin.
Internal in core/modules/ckeditor/src/Plugin/CKEditorPlugin/Internal.php
Defines the "internal" plugin (i.e. core plugins part of our CKEditor build).
Language in core/modules/ckeditor/src/Plugin/CKEditorPlugin/Language.php
Defines the "language" plugin.

... See full list

File

core/modules/ckeditor/src/Annotation/CKEditorPlugin.php, line 22

Namespace

Drupal\ckeditor\Annotation
View on git.drupalcode.org
View source 
class CKEditorPlugin extends Plugin {
    
    /**
     * The plugin ID.
     *
     * This MUST match the name of the CKEditor plugin itself (written in
     * JavaScript). Otherwise CKEditor will throw JavaScript errors when it runs,
     * because it fails to load this CKEditor plugin.
     *
     * @var string
     */
    public $id;
    
    /**
     * The human-readable name of the CKEditor plugin.
     *
     * @ingroup plugin_translatable
     *
     * @var \Drupal\Core\Annotation\Translation
     */
    public $label;

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
CKEditorPlugin::$id public property The plugin ID.
CKEditorPlugin::$label public property The human-readable name of the CKEditor 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 6
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass 1
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 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass 1
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. 3

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.