class ImageEffect

Same name in other branches
  1. 9 core/modules/image/src/Annotation/ImageEffect.php \Drupal\image\Annotation\ImageEffect
  2. 8.9.x core/modules/image/src/Annotation/ImageEffect.php \Drupal\image\Annotation\ImageEffect
  3. 11.x core/modules/image/src/Attribute/ImageEffect.php \Drupal\image\Attribute\ImageEffect
  4. 11.x core/modules/image/src/Annotation/ImageEffect.php \Drupal\image\Annotation\ImageEffect

Defines an ImageEffect attribute for plugin discovery.

Plugin Namespace: Plugin\ImageEffect

For a working example, see \Drupal\image\Plugin\ImageEffect\ResizeImageEffect

Attributes

#[\Attribute(\Attribute::TARGET_CLASS)]

Hierarchy

  • class \Drupal\image\Attribute\ImageEffect extends \Drupal\Component\Plugin\Attribute\Plugin

Expanded class hierarchy of ImageEffect

See also

hook_image_effect_info_alter()

\Drupal\image\ConfigurableImageEffectInterface

\Drupal\image\ConfigurableImageEffectBase

\Drupal\image\ImageEffectInterface

\Drupal\image\ImageEffectBase

\Drupal\image\ImageEffectManager

\Drupal\Core\ImageToolkit\Attribute\ImageToolkitOperation

Plugin API

11 files declare their use of ImageEffect
AjaxTestImageEffect.php in core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php
ConvertImageEffect.php in core/modules/image/src/Plugin/ImageEffect/ConvertImageEffect.php
CropImageEffect.php in core/modules/image/src/Plugin/ImageEffect/CropImageEffect.php
DesaturateImageEffect.php in core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php
ImageEffectManager.php in core/modules/image/src/ImageEffectManager.php

... See full list

File

core/modules/image/src/Attribute/ImageEffect.php, line 27

Namespace

Drupal\image\Attribute
View source 
class ImageEffect extends Plugin {
    
    /**
     * Constructs an ImageEffect attribute.
     *
     * @param string $id
     *   The plugin ID.
     * @param \Drupal\Core\StringTranslation\TranslatableMarkup $label
     *   The human-readable name of the image effect.
     * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $description
     *   (optional) A brief description of the image effect. This will be shown
     *   when adding or configuring this image effect.
     * @param class-string|null $deriver
     *   (optional) The deriver class.
     */
    public function __construct(string $id, TranslatableMarkup $label, ?TranslatableMarkup $description = NULL, ?string $deriver = NULL) {
    }

}

Members

Title Modifiers Object type Summary
ImageEffect::__construct public function Constructs an ImageEffect attribute.

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