Descripción

strpos(string $haystack, string $needle, int $offset = 0): int|false

Busca la posición numérica de la primera ocurrencia de needle en el string haystack.

Parámetros

haystack

El string en el que se debe buscar.

needle

El string a buscar.

Anterior a PHP 8.0.0, si needle no es una cadena de caracteres, se convierte en un entero y se aplica como valor ordinal de un carácter. Este comportamiento está obsoleto a partir de PHP 7.3.0, y confiar en él está fuertemente desaconsejado. Dependiendo del comportamiento esperado, needle debe ser explícitamente convertido a una cadena de caracteres, o debe realizarse una llamada explícita a chr().

offset

Si se especifica, la búsqueda comenzará a partir de este número de caracteres contados desde el inicio del string. Si este número es negativo, la búsqueda comenzará utilizando este número de caracteres pero comenzando desde el final del string.

Valores devueltos

Devuelve la posición numérica de la ocurrencia en relación con el inicio del string haystack (independientemente del offset). Nótese también que la posición en el string comienza en 0, y no en 1.

Devuelve false si la ocurrencia no ha sido encontrada.

Advertencia

Esta función puede retornar false, pero también puede retornar un valor equivalente a false. Por favor, lea la sección sobre los booleanos para más información. Utilice el operador === para probar el valor de retorno exacto de esta función.

Errores/Excepciones

Si offset es mayor que la longitud de haystack, se lanzará un ValueError.

Historial de cambios

Versión	Descripción
8.0.0	`needle` acepta ahora una cadena vacía.
8.0.0	Pasar un int como `needle` ya no está soportado.
7.3.0	Pasar un int como `before_needle` ha sido declarado obsoleto.
7.1.0	Se ha añadido soporte para números negativos en el parámetro `offset`.

Ejemplos

Ejemplo #1 Con ===

<?php
$mystring = 'abc';
$findme   = 'a';
$pos = strpos($mystring, $findme);

// Note nuestra utilización de ===.  == no funcionaría como esperado
// ya que la posición de 'a' es el carácter 0 (primero).
if ($pos === false) {
    echo "El string '$findme' no se encuentra en el string '$mystring'";
} else {
    echo "El string '$findme' ha sido encontrado en el string '$mystring'";
    echo " y comienza en la posición $pos";
}
?>

Ejemplo #2 Con !==

<?php
$mystring = 'abc';
$findme   = 'a';
$pos = strpos($mystring, $findme);

// Note nuestra utilización de !==.  != no funcionaría como esperado
// ya que la posición de 'a' es el carácter 0 (primero).
if ($pos !== false) {
    echo "El string '$findme' ha sido encontrado en el string '$mystring'";
    echo " y comienza en la posición $pos";
} else {
    echo "El string '$findme' no se encuentra en el string '$mystring'";
}
?>

Ejemplo #3 Utilizar un offset

<?php
// Podemos buscar el carácter, e ignorar todo lo que está antes del offset
$newstring = 'abcdef abcdef';
$pos = strpos($newstring, 'a', 1); // $pos = 7, no 0
echo $pos, PHP_EOL;
?>

Notas

Nota: Esta función es segura para sistemas binarios.

Ver también

stripos() - Busca la posición de la primera ocurrencia en un string, sin distinguir mayúsculas de minúsculas
str_contains() - Determina si una cadena contiene un substring dado
str_ends_with() - Determina si una cadena termina con un substring dado
str_starts_with() - Determina si un string comienza con un substring dado
strrpos() - Busca la posición de la última ocurrencia de una subcadena en una cadena
strripos() - Busca la posición de la última ocurrencia de un string contenido en otro, de forma insensible a mayúsculas y minúsculas
strstr() - Encuentra la primera ocurrencia en un string
strpbrk() - Busca un conjunto de caracteres en un string
substr() - Devuelve un segmento de string
preg_match() - Realiza una búsqueda de coincidencia con una expresión regular estándar