Description
The ICOUK Hijri Month plugin allows you to easily display the Hijri month calendar on your WordPress website. Perfect for Islamic websites, mosques, and communities who need to show the full Islamic calendar month.
Features
- Display Hijri month calendar using shortcode
- Configurable country settings
- Secure API authentication
- Easy to use and integrate
- Responsive design
- Error handling and user feedback
How to Use
- Install and activate the plugin
- Go to Settings > ICOUK Hijri Month
- Enter your API Bearer token
- Set your country (defaults to UK)
- Use the shortcode
[icouk_hijri_month]in any post or page
Shortcode
Use the shortcode [icouk_hijri_month] to display the Hijri month calendar anywhere on your website.
Shortcode Attributes:
– width – Override the default width (e.g., [icouk_hijri_month width="800px"])
Configuration
The plugin requires configuration before use:
- Bearer Token: Enter your Moon Sighting UK API authentication token
- Country: Set your country code (defaults to UK)
- Calendar Width: Set the default width for the calendar (e.g., “100%”, “500px”)
API Integration
This plugin integrates with the Moon Sighting UK API to fetch accurate Hijri calendar information. The API is free to ICOUK registered members. You’ll need to obtain an API key from the Moon Sighting UK service.
External Services
This plugin connects to the Moon Sighting UK API to obtain Hijri month calendar information. This service is required to display the accurate Islamic calendar month on your website.
What data is sent and when:
– Your configured country code (e.g., “UK”, “MA”) is sent with each API request
– Your Bearer token is sent for authentication
– API requests are made when the shortcode is displayed on your website
– Data is cached for 10 minutes to reduce API calls
Service Provider: Moon Sighting UK (ICOUK)
– Website: https://www.moonsighting.org.uk/
– API Endpoint: https://www.moonsighting.org.uk/api/index.php/v1/
– Terms of Service: https://www.moonsighting.org.uk/terms-of-use.html
– Privacy Policy: https://www.moonsighting.org.uk/privacy-policy.html
Data Transmission:
– Country code and Bearer token are transmitted over HTTPS
– No personal user data is collected or transmitted
– API responses are cached locally to minimize external requests
Installation
- Upload the plugin files to the
/wp-content/plugins/icouk-hijri-monthdirectory, or install the plugin through the WordPress admin screen. - Activate the plugin through the ‘Plugins’ screen in WordPress
- Go to Settings > ICOUK Hijri Month to configure the API settings
- Use the shortcode
[icouk_hijri_month]in your posts or pages
FAQ
-
Do I need an API key?
-
Yes, you need a Bearer token from the Moon Sighting UK API service to use this plugin.
-
Can I change the country?
-
Yes, you can configure the country in the plugin settings. The default is UK.
-
Where can I use the shortcode?
-
You can use the shortcode
[icouk_hijri_month]in posts, pages, widgets, or any area that supports shortcodes. -
What if the API is down?
-
The plugin includes error handling and will display a user-friendly error message if the API is unavailable.
-
Is this plugin free?
-
Yes, this plugin is free to use and is released under the GPL license.
-
What’s the difference between this and the Hijri Date plugin?
-
This plugin displays the full month calendar, while the Hijri Date plugin shows only the current date.
Reviews
There are no reviews for this plugin.
Contributors & Developers
“ICOUK Hijri Month” is open source software. The following people have contributed to this plugin.
ContributorsTranslate “ICOUK Hijri Month” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
1.0.0
- Initial release
- Basic Hijri month calendar display functionality
- Settings page for API configuration
- Shortcode support
- Error handling
- Calendar width configuration
