Pagefile::filedata() method

Get or set filedata

Filedata is any additional data that you want to store with the file’s database record.

  • To get a value, specify just the $key argument. Null is returned if request value is not present.
  • To get all values, omit all arguments. An associative array will be returned.
  • To set a value, specify the $key and the $value to set.
  • To set all values at once, specify an associative array for the $key argument.
  • To unset, specify boolean false (or null) for $key, and the name of the property to unset as $value.
  • To unset, you can also get all values, unset it from the retuned array, and set the array back.

Usage

// basic usage
$mixed = $pagefile->filedata();

// usage with all arguments
$mixed = $pagefile->filedata($key = '', $value = null);

Arguments

NameType(s)Description
key (optional)string, array, false, null

Specify array to set all file data, or key (string) to set or get a property, Or specify boolean false to remove key specified by $value argument.

value (optional)null, string, array, int, float

Specify a value to set for given property

Return value

mixed


Pagefile methods and properties

API reference based on ProcessWire core version 3.0.163

Twitter updates

  • This week we’re proud to announce the newest ProcessWire master version 3.0.164. Relative to the previous master (3.0.148) this version adds a ton of new & useful features and fixes more than 85 issues, with more than 225 commits over 7 months— More
    7 August 2020
  • ProcessWire 3.0.163 resolves more than a dozen issue reports and adds new hooks and configurable module install options, among numerous other updates. In addition, a major update to ProCache (v4.0) has been released— More
    24 July 2020
  • Weekly update for 17 July 2020 and a look at new features coming in next week's version of ProCache— More
    17 July 2020

Latest news

  • ProcessWire Weekly #326
    In the 326th issue of ProcessWire Weekly we're going to introduce the latest ProcessWire master version, take a quick look at a brand new third party module called Textformatter Video Markup, and more. Read on!
    Weekly.pw / 8 August 2020
  • ProcessWire 3.0.164 new master version
    This week we’re proud to announce the newest ProcessWire master version 3.0.164. Relative to the previous master version (3.0.148) this version adds a ton of new and useful features and fixes more than 85 issues, with more than 225 commits over a period of 7 months.
    Blog / 7 August 2020
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer