metaphone

FunctionDeprecated in PHP 8.6

Calculate the metaphone key of a string.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6
Deprecated

metaphone Function synopsis

#[\Deprecated]
metaphone(string $string, int $max_phonemes = 0): string

Parameters

$string

Typestring

The input string.

$max_phonemes

OptionalTypeintDefault value0

This parameter restricts the returned metaphone key to $max_phonemes characters in length. However, the resulting phonemes are always transcribed completely, so the resulting string length may be slightly longer than $max_phonemes. The default value of 0 means no restriction.

Return value

Typestring

Returns the metaphone key as a string.

Changes to the metaphone Function

PHP 8.6

  • Function deprecated

PHP 8.0

  • Return type added: string
  • Parameter name of parameter #1 changed: $text to $string
  • Parameter type added for parameter #1 ($string): string
  • Parameter name of parameter #2 changed: $phones to $max_phonemes
  • Parameter type added for parameter #2 ($max_phonemes): int
  • Parameter default value added for position #2 ($max_phonemes): 0
- metaphone($text, $phones)
+ metaphone(string $string, int $max_phonemes = 0): string

metaphone Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes Deprecated
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes