Calculate public holidays for a country

This package can calculate public holidays for a country.

use Spatie\Holidays\Holidays;

// returns an array of Belgian holidays
// for the current year
$holidays = Holidays::for('be')->get();

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require spatie/holidays

Supported countries

We support the countries listed in this directory. If you want to add a country, please create a pull request.

Usage

You can get all holidays for a country by using the get method.

use Spatie\Holidays\Holidays;

// returns an array of Belgian holidays
// for the current year
$holidays = Holidays::for('be')->get();

Alternatively, you could also pass an instance of Country to the for method.

use Spatie\Holidays\Holidays;
use Spatie\Holidays\Countries\Belgium;

// returns an array of Belgian holidays
// for the current year
$holidays = Holidays::for(Belgium::make())->get();

Getting holidays for a specific year

You can also pass a specific year.

use Spatie\Holidays\Holidays;

$holidays = Holidays::for(country: 'be', year: 2024))->get();

Determining if a date is a holiday

If you need to see if a date is a holiday, you can use the isHoliday method.

use Spatie\Holidays\Holidays;

Holidays::for('be')->isHoliday('2024-01-01'); // true

Getting the name of a holiday

If you need the name of the holiday, you can use the getName method.

use Spatie\Holidays\Holidays;

Holidays::for('be')->getName('2024-01-01'); // Nieuwjaar

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

eyedroot/holidays