function ImageStyleInterface::createDerivative

Same name in other branches
  1. 9 core/modules/image/src/ImageStyleInterface.php \Drupal\image\ImageStyleInterface::createDerivative()
  2. 8.9.x core/modules/image/src/ImageStyleInterface.php \Drupal\image\ImageStyleInterface::createDerivative()
  3. 11.x core/modules/image/src/ImageStyleInterface.php \Drupal\image\ImageStyleInterface::createDerivative()

Creates a new image derivative based on this image style.

Generates an image derivative applying all image effects and saving the resulting image.

Parameters

string $original_uri: Original image file URI.

string $derivative_uri: Derivative image file URI.

Return value

bool TRUE if an image derivative was generated, or FALSE if the image derivative could not be generated.

1 method overrides ImageStyleInterface::createDerivative()
ImageStyle::createDerivative in core/modules/image/src/Entity/ImageStyle.php
Creates a new image derivative based on this image style.

File

core/modules/image/src/ImageStyleInterface.php, line 104

Class

ImageStyleInterface
Provides an interface defining an image style entity.

Namespace

Drupal\image

Code

public function createDerivative($original_uri, $derivative_uri);

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