PHP String str_ends_with() Function



The PHP String str_ends_with() function is a built-in method. It is basically used to check if a string ends with a given substring. This function returns TRUE if the string ends with the substring, and FALSE otherwise. It is very similar to str.starts_with().

The only difference between str-starts_with() and str_ends_with() is that str-starts_with() looks for the substring at the beginning of the string, while str_ends_with() looks for the substring at the end of the string.

Syntax

Below is the syntax of the PHP String str_ends_with() function −

bool str_ends_with ( string $string, string $search )

Parameters

Here are the parameters of the str_ends_with() function −

  • $string − (Required) It refers to the string whose end string must be searched.

  • $search − (Required) It is the string to be searched in the $string.

Return Value

The str_ends_with() function returns a boolean value: TRUE if $string ends with $substring, FALSE otherwise.

PHP Version

This function is introduced in core PHP 8.

Example 1

Here is the basic example of the PHP String str_ends_with() function to check if a string ends with the given substring.

<?php
   // Define the string here
   $string = "Hello, World!";
   $search = "World!";

   echo str_ends_with($string, $search);
?>

Output

Here is the outcome of the following code −

1

Example 2

In the below PHP code we will use the str_ends_with() function and show that the function is case-sensitive.

<?php
   // Define string here
   $string = "Learn PHP Programming";
   $search = "programming";

   if (str_ends_with($string, $search)) {
      echo "The string ends with '$search'.";
   } else {
      echo "The string does not end with '$search'.";
   }
?> 

Output

This will generate the below output −

The string does not end with 'programming'.

Example 3

Now the below code uses the str_ends_with() function for checking multiple substrings dynamically with help of an array.

<?php
   // Define the string here
   $string = "PHP is fun and easy to learn!";
   $substrings = ["learn!", "fun", "easy"];

   foreach ($substrings as $search) {
      if (str_ends_with($string, $search)) {
         echo "The string ends with '$search'.\n";
      } else {
         echo "The string does not end with '$search'.\n";
      }
   }
?> 

Output

This will create the below output −

The string ends with 'learn!'.
The string does not end with 'fun'.
The string does not end with 'easy'.

Example 4

In the following example, we are using the str_ends_with() function and validate that a file name ends with a valid extension.

<?php
   // Define the string here
   $filename = "picture.jpg";
   $extensions = [".jpg", ".png", ".gif"];

   $isValid = false;

   foreach ($extensions as $extension) {
      if (str_ends_with($filename, $extension)) {
         $isValid = true;
         break;
      }
   }

   if ($isValid) {
      echo "The file '$filename' has a valid extension.";
   } else {
      echo "The file '$filename' does not have a valid extension.";
   }
?> 

Output

Following is the output of the above code −

The file 'picture.jpg' has a valid extension.
php_function_reference.htm
Advertisements