PHP | Imagick frameImage() Function

The Imagick::frameImage() function is an inbuilt function in PHP which is used to add a three-dimensional border around the image.

Syntax:

bool Imagick::frameImage( $color, $width, $height, $inner_bevel, $outer_bevel )

Parameters: This function accepts five parameters as mentioned above and described below:

• $color: The color of the border which can be a string or in a hexadecimal format.
• $width: It sets the width of the border.
• $height: It sets the height of the border.
• $inner_bevel: It sets the width of inner bevel shadow.
• $outer_bevel: It sets the width of outer bevel shadow.

Return Value: It returns True on success or False on failure.

Below programs illustrate the Imagick::frameImage() function in PHP:

Program 1:

<?php

// Create an Imagick object
$imagick = new Imagick(
'https://media.geeksforgeeks.org/wp-content/uploads/geeksforgeeks-9.png');

// Use frameImage function
$imagick->frameImage('yellow', 30, 30, 10, 10);

header("Content-Type: image/jpg");

// Display the output image
echo $imagick->getImageBlob();

?>

Output:

Program 2:

<?php

// Create new Imagick object
$image = new Imagick(__DIR__.'\sample_image.jpeg');

// Set the value of parameters
$color = "#211544";
$width_of_frame = 30;
$height_of_frame = 40;
$inner_Bevel = 15;
$outer_Bevel = 15;

// Call the function with parameters
$image->frameImage(
    $color,
    $width_of_frame,
    $height_of_frame,
    $inner_Bevel,
    $outer_Bevel
);

header('Content-type: image/jpeg');

// Writing the new image to specified directory
$image->writeImage(__DIR__.'\sample_image_with_border2.jpeg');

?>

Output:

Program 3:

<?php

// Create a function which accepts the parameters
// and returns the framed image object
function frame_image($Imagik_obj, $color, $width_of_frame,
                $height_of_frame, $inner_bevel, $outer_bevel)
{
    $Imagik_obj->frameImage(
        $color,
        $width_of_frame,
        $height_of_frame,
        $inner_Bevel,
        $outer_Bevel
    );

    return $Imagik_obj;
}

// Call the function with the parameters
echo frame_image(new Imagick(__DIR__.'\sample_image.jpeg'),
                 "#211544", 30, 40, 15, 15)->getImageBlob();

header('Content-type: image/jpeg');

?>

Output:

Reference : https://www.php.net/manual/en/imagick.frameimage.php
Please comment if you find something wrong or want to add some more information. Happy coding!!