ImageEffect.php

Same filename in this branch
  1. 10 core/modules/image/src/Annotation/ImageEffect.php
Same filename in other branches
  1. 9 core/modules/image/src/Annotation/ImageEffect.php
  2. 8.9.x core/modules/image/src/Annotation/ImageEffect.php
  3. 11.x core/modules/image/src/Attribute/ImageEffect.php
  4. 11.x core/modules/image/src/Annotation/ImageEffect.php

Namespace

Drupal\image\Attribute

File

core/modules/image/src/Attribute/ImageEffect.php

View source
<?php

declare (strict_types=1);
namespace Drupal\image\Attribute;

use Drupal\Component\Plugin\Attribute\Plugin;
use Drupal\Core\StringTranslation\TranslatableMarkup;

/**
 * Defines an ImageEffect attribute for plugin discovery.
 *
 * Plugin Namespace: Plugin\ImageEffect
 *
 * For a working example, see
 * \Drupal\image\Plugin\ImageEffect\ResizeImageEffect
 *
 * @see hook_image_effect_info_alter()
 * @see \Drupal\image\ConfigurableImageEffectInterface
 * @see \Drupal\image\ConfigurableImageEffectBase
 * @see \Drupal\image\ImageEffectInterface
 * @see \Drupal\image\ImageEffectBase
 * @see \Drupal\image\ImageEffectManager
 * @see \Drupal\Core\ImageToolkit\Attribute\ImageToolkitOperation
 * @see plugin_api
 */
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) {
    }

}

Classes

Title Deprecated Summary
ImageEffect Defines an ImageEffect attribute for plugin discovery.

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