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.

Example

// 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');

Usage

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

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

Arguments

NameType(s)Description
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.178

Twitter updates

  • Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we’ll take a closer look at in this post— More
    11 June 2021
  • ProcessWire 3.0.179 adds great new admin theme customization tools that put you in full control over the Uikit admin styles— More
    28 May 2021
  • ProcessWire updates for week of 21 May 2021— More
    22 May 2021

Latest news

  • ProcessWire Weekly #370
    In the 370th issue of ProcessWire Weekly we're going to check out the latest version of the commercial FormBuilder module, introduce a couple of brand new third party modules, and more. Read on!
    Weekly.pw / 12 June 2021
  • ProcessWire FormBuilder v50 updates
    Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we'll take a closer look at in this post.
    Blog / 11 June 2021
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH