public function Image::createNew in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Image/Image.php \Drupal\Core\Image\Image::createNew()
2. 10 core/lib/Drupal/Core/Image/Image.php \Drupal\Core\Image\Image::createNew()

Prepares a new image, without loading it from a file.

For a working example, see \Drupal\system\Plugin\ImageToolkit\Operation\gd\CreateNew.

Parameters

int $width: The width of the new image, in pixels.

int $height: The height of the new image, in pixels.

string $extension: (optional) The extension of the image file (for instance, 'png', 'gif', etc.). Allowed values depend on the implementation of the image toolkit. Defaults to 'png'.

string $transparent_color: (optional) The hexadecimal string representing the color to be used for transparency, needed for GIF images. Defaults to '#ffffff' (white).

Return value

bool TRUE on success, FALSE on failure.

Overrides ImageInterface::createNew

File

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

Class

Image

Defines an image object to represent an image file.

Namespace

Drupal\Core\Image

Code

public function createNew($width, $height, $extension = 'png', $transparent_color = '#ffffff') {
  return $this
    ->apply('create_new', [
    'width' => $width,
    'height' => $height,
    'extension' => $extension,
    'transparent_color' => $transparent_color,
  ]);
}