function ImageEffectInterface::applyEffect

Same name in other branches
  1. 8.9.x core/modules/image/src/ImageEffectInterface.php \Drupal\image\ImageEffectInterface::applyEffect()
  2. 10 core/modules/image/src/ImageEffectInterface.php \Drupal\image\ImageEffectInterface::applyEffect()
  3. 11.x core/modules/image/src/ImageEffectInterface.php \Drupal\image\ImageEffectInterface::applyEffect()

Applies an image effect to the image object.

Parameters

\Drupal\Core\Image\ImageInterface $image: An image file object.

Return value

bool TRUE on success. FALSE if unable to perform the image effect on the image.

7 methods override ImageEffectInterface::applyEffect()
AjaxTestImageEffect::applyEffect in core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php
Applies an image effect to the image object.
ConvertImageEffect::applyEffect in core/modules/image/src/Plugin/ImageEffect/ConvertImageEffect.php
Applies an image effect to the image object.
DesaturateImageEffect::applyEffect in core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php
Applies an image effect to the image object.
NullTestImageEffect::applyEffect in core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/NullTestImageEffect.php
Applies an image effect to the image object.
ResizeImageEffect::applyEffect in core/modules/image/src/Plugin/ImageEffect/ResizeImageEffect.php
Applies an image effect to the image object.

... See full list

File

core/modules/image/src/ImageEffectInterface.php, line 31

Class

ImageEffectInterface
Defines the interface for image effects.

Namespace

Drupal\image

Code

public function applyEffect(ImageInterface $image);

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