function DeprecatedSniff::getDeprecationMessage

Optionally provide an arbitrary custom message to display with the deprecation.

Typically intended to allow for displaying information about what to replace the deprecated sniff with. Example: "Use the Stnd.Cat.SniffName sniff instead." Multi-line messages (containing new line characters) are supported.

An empty string can be returned if there is no replacement/no need for a custom message.

Return value

string

File

vendor/squizlabs/php_codesniffer/src/Sniffs/DeprecatedSniff.php, line 60

Class

DeprecatedSniff

Namespace

PHP_CodeSniffer\Sniffs

Code

public function getDeprecationMessage();