You are here

public function Image::convert in Drupal 9

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Image/Image.php \Drupal\Core\Image\Image::convert()

Instructs the toolkit to save the image in the format specified by the extension.

Parameters

string $extension: The extension to convert to (for instance, 'jpeg' or 'png'). Allowed values depend on the current image toolkit.

Return value

bool TRUE on success, FALSE on failure.

Overrides ImageInterface::convert

See also

\Drupal\Core\ImageToolkit\ImageToolkitInterface::getSupportedExtensions()

File

core/lib/Drupal/Core/Image/Image.php, line 155

Class

Image
Defines an image object to represent an image file.

Namespace

Drupal\Core\Image

Code

public function convert($extension) {
  return $this
    ->apply('convert', [
    'extension' => $extension,
  ]);
}