Field::getDescription() method

Return field description for current language, or another specified language.

This is different from $field->description in that it knows about languages (when installed).

Usage

// basic usage
$string = $field->getDescription();

// usage with all arguments
$string = $field->getDescription($language = null);

Arguments

NameType(s)Description
$language (optional)Page Language

Optionally specify a language. If not specified user's current language is used.

Return value

string

$field methods and properties

API reference based on ProcessWire core version 3.0.252