function ImageInterface::convert

Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Image/ImageInterface.php \Drupal\Core\Image\ImageInterface::convert()
  2. 10 core/lib/Drupal/Core/Image/ImageInterface.php \Drupal\Core\Image\ImageInterface::convert()
  3. 11.x core/lib/Drupal/Core/Image/ImageInterface.php \Drupal\Core\Image\ImageInterface::convert()

Converts an image to 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.

See also

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

1 method overrides ImageInterface::convert()
Image::convert in core/lib/Drupal/Core/Image/Image.php
Converts an image to the format specified by the extension.

File

core/lib/Drupal/Core/Image/ImageInterface.php, line 184

Class

ImageInterface
Provides an interface for image objects.

Namespace

Drupal\Core\Image

Code

public function convert($extension);

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