PHP Conference Fukuoka 2025

fnmatch

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

fnmatchPrueba un nombre de fichero mediante un patrón de búsqueda

Descripción

fnmatch(string $pattern, string $filename, int $flags = 0): bool

fnmatch() verifica si la cadena filename cumple con el patrón de shell pattern.

Parámetros

pattern

El pattern a comparar. Habitualmente, el pattern contendrá caracteres genéricos como '?' y '*'.

Caracteres genéricos a utilizar en el parámetro pattern
Carácter genérico Descripción
? El signo de interrogación coincidirá con cualquier carácter único. Por ejemplo, el patrón "file?.txt" coincidirá con "file1.txt" y "fileA.txt", pero no coincidirá con "file10.txt".
* El asterisco coincidirá con cero o más caracteres. Por ejemplo, el patrón "foo*.xml" coincidirá con "foo.xml" y "foobar.xml".
[ ] Los corchetes se utilizan para crear rangos de puntos de código ASCII o conjuntos de caracteres. Por ejemplo, el patrón "index.php[45]" coincidirá con "index.php4" y "index.php5", pero no coincidirá con "index.phpt". Rangos conocidos son [0-9], [a-z] y [A-Z]. Varios conjuntos y rangos pueden utilizarse simultáneamente, por ejemplo [0-9a-zABC].
! El signo de exclamación se utiliza para negar caracteres dentro de los corchetes. Por ejemplo, "[!A-Z]*.html" coincidirá con "demo.html", pero no coincidirá con "Demo.html".
\ La barra invertida se utiliza para escapar caracteres especiales. Por ejemplo, "Name\?" coincidirá con "Name?", pero no coincidirá con "Names".

filename

La cadena a probar. Esta función es particularmente útil para los nombres de fichero, pero también puede utilizarse con cadenas regulares.

El usuario medio de Shell puede estar familiarizado con los patrones de Shell, o al menos, sus expresiones más simples, como '?' y '*'. De esta manera, utilizar fnmatch() en lugar de preg_match() para búsquedas puede ser más práctico para los no iniciados.

flags

El valor de flags puede ser una combinación de los siguientes flags, unidos con el operador binario OR (|).

Lista de flags posibles para fnmatch()
Flag Descripción
FNM_NOESCAPE Desactiva el escape de las barras invertidas.
FNM_PATHNAME Una barra diagonal en una cadena coincide únicamente con una barra diagonal en el patrón proporcionado.
FNM_PERIOD Un punto al inicio de la cadena debe coincidir exactamente con un punto en el patrón proporcionado.
FNM_CASEFOLD Las coincidencias no distinguen mayúsculas y minúsculas. Forma parte de la extensión GNU.

Valores devueltos

Devuelve true si hay resultados, false en caso contrario.

Ejemplos

Ejemplo #1 Verificar el nombre de un color con un patrón de Shell

<?php
if (fnmatch("*gr[ae]y", $color)) {
echo
"formas de gris ...";
}
?>

Notas

Advertencia

Actualmente, esta función no está disponible para sistemas no-POSIX, a excepción de Windows.

Ver también

  • glob() - Búsqueda de rutas que coinciden con un patrón
  • preg_match() - Realiza una búsqueda de coincidencia con una expresión regular estándar
  • sscanf() - Analiza una cadena utilizando un formato
  • printf() - Muestra una string formateada
  • sprintf() - Devuelve una string formateada

add a note

User Contributed Notes 7 notes

up
14
me at rowanlewis dot com
15 years ago
Here's a definitive solution, which supports negative character classes and the four documented flags.

<?php
    
    if (!function_exists('fnmatch')) {
        define('FNM_PATHNAME', 1);
        define('FNM_NOESCAPE', 2);
        define('FNM_PERIOD', 4);
        define('FNM_CASEFOLD', 16);
        
        function fnmatch($pattern, $string, $flags = 0) {
            return pcre_fnmatch($pattern, $string, $flags);
        }
    }
    
    function pcre_fnmatch($pattern, $string, $flags = 0) {
        $modifiers = null;
        $transforms = array(
            '\*'    => '.*',
            '\?'    => '.',
            '\[\!'    => '[^',
            '\['    => '[',
            '\]'    => ']',
            '\.'    => '\.',
            '\\'    => '\\\\'
        );
        
        // Forward slash in string must be in pattern:
        if ($flags & FNM_PATHNAME) {
            $transforms['\*'] = '[^/]*';
        }
        
        // Back slash should not be escaped:
        if ($flags & FNM_NOESCAPE) {
            unset($transforms['\\']);
        }
        
        // Perform case insensitive match:
        if ($flags & FNM_CASEFOLD) {
            $modifiers .= 'i';
        }
        
        // Period at start must be the same as pattern:
        if ($flags & FNM_PERIOD) {
            if (strpos($string, '.') === 0 && strpos($pattern, '.') !== 0) return false;
        }
        
        $pattern = '#^'
            . strtr(preg_quote($pattern, '#'), $transforms)
            . '$#'
            . $modifiers;
        
        return (boolean)preg_match($pattern, $string);
    }
    
?>

This probably needs further testing, but it seems to function identically to the native fnmatch implementation.
up
1
Sinured
17 years ago
An addition to my previous note: My statement regarding the FNM_* constants was wrong. They are available on POSIX-compliant systems (in other words, if fnmatch() is defined).
up
0
bernd dot ebert at gmx dot net
13 years ago
There is a problem within the  pcre_fnmatch-Function concerning backslashes. Those will be masked by preq_quote and ADDITONALLY by the strtr if FN_NOESCAPE is not set -> something like "*a(*" will finally result in "#^.*a\\(.*$#". Note the double backslash which effectively does NOT mask the "(" correctly. Since preq_quote always matches a backslash I don't think that this'll work with using preg_quote at all.
up
0
Frederik Krautwald
18 years ago
soywiz's function still doesn't seem to work -- at least not with PHP 5.2.3 on Windows -- but jk's does.
up
-1
jk at ricochetsolutions dot com
18 years ago
soywiz's function didnt seem to work for me, but this did.<?phpif(!function_exists('fnmatch')) {    function fnmatch($pattern, $string) {        return preg_match("#^".strtr(preg_quote($pattern, '#'), array('\*' => '.*', '\?' => '.'))."$#i", $string);    } // end} // end if?>
up
-2
theboydanny at gmail dot com
17 years ago
About the windows compat functions below:I needed fnmatch for a application that had to work on Windows, took a look here and tested both. Jk's works for me, soywiz didn't (on WinXPSP2, PHP 5.2.3).The only difference between them is addcslashes (soywiz) instead of preg_quote (jk). They _should_ both work, but for some reason soywiz's didn't for me. So YMMV.However, to make JK's fnmatch() work with the example in the documentation, you also have to strtr the [ and ] in $pattern.<?php$pattern = strtr(preg_quote($pattern, '#'), array('\*' => '.*', '\?' => '.', '\[' => '[', '\]' => ']'));?>And thanks for the functions, guys.
up
-3
phlipping at yahoo dot com
22 years ago
you couls also try this function that I wrote before I found fnmatch:function WildToReg($str){  $s = "";     for ($i = 0; $i < strlen($str); $i++)  {   $c = $str{$i};   if ($c =='?')    $s .= '.'; // any character   else if ($c == '*')        $s .= '.*'; // 0 or more any characters       else if ($c == '[' || $c == ']')    $s .= $c;  // one of characters within []   else    $s .= '\\' . $c;  }  $s = '^' . $s . '$';  //trim redundant ^ or $  //eg ^.*\.txt$ matches exactly the same as \.txt$  if (substr($s,0,3) == "^.*")   $s = substr($s,3);  if (substr($s,-3,3) == ".*$")   $s = substr($s,0,-3);  return $s;}if (ereg(WildToReg("*.txt"), $fn))  print "$fn is a text file";else  print "$fn is not a text file";
To Top