Pagefile::description() method

Get or set the file’s description (with multi-language support).

When not in a multi-language environment, you can still use this method but we recommend using the simpler method of just getting/seting the Pagefile::$description property directly instead.


// Get a Pagefile to work with
$pagefile = $page->files->first();

// Setting description
$pagefile->description('en', 'Setting English description');
$pagefile->description('de', 'Setting German description');

// Getting description for current language (whatever it happens to be)
echo $pagefile->description();

// Getting description for language "de"
echo $pagefile->description('de');


// basic usage
$string = $pagefile->description();

// usage with all arguments
$string = $pagefile->description($language = null, $value = null);


language (optional)
value (optional)null, string

Specify only when you are setting (single language) rather than getting a value.

Return value

string array

Pagefile methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #526
    In the 526th issue of ProcessWire Weekly we'll cover the latest news from the ProcessWire community: newly open sourced Functional Fields module, new site profile to accompany RockFrontend, and more. Read on! / 8 June 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani