Pageimage::width()

Return the width of this image OR return an image sized with a given width (and proportional height).

  • If given a width, it'll return a new Pageimage object sized to that width.
  • If not given a width, it'll return the current width of this Pageimage.

Example

// Get width of image
$px = $image->width();

// Create a new variation at 200px width
$thumb = $image->width(200);

Usage

// basic usage
$int = $pageimage->width();

// usage with all arguments
$int = $pageimage->width(int $n = 0, $options = []);

Arguments

NameType(s)Description
$n (optional)int

Optional width if you are creating a new size.

$options (optional)array string int bool

See Pageimage::size() $options argument for details.

Return value

int Pageimage

Returns width (in px) when given no arguments, or Pageimage when given a width argument.

Pageimage methods and properties

API reference based on ProcessWire core version 3.0.251