Barakah – Ramadan Prayer Times

Barakah is a WordPress plugin for Ramadan prayer times, Sehri/Iftar highlights, dua content, greeting popup, and a configurable sticky prayer bar.

It is powered by the free Aladhan API (no API key required).

Current Version

1.0.1

Features

• Prayer times widget via shortcode: [barakah]
• New widget variants via shortcode:
  • [barakah widget="prayer_times"]
  • [barakah widget="ramadan"]
  • [barakah widget="hadith"]
  • [barakah widget="dua"]
  • [barakah widget="date"]
• Live clock and countdown to next prayer
• Sehri and Iftar highlight cards
• Full daily prayer list with active/next states
• Ramadan month modal (Hijri calendar + Sehri/Iftar times)
• Daily dua/zikr rotation (English + Bangla data support)
• Header/footer greetings
• Greeting popup with page targeting:
  • all pages
  • specific selected pages
• Sticky prayer bar with:
  • header/footer position
  • dark/light theme
  • page targeting (all/specific pages)
  • delayed open behavior and collapsible side tab
• Optional visitor location change
• Hijri adjustment and caution-minute adjustments
• Transient caching with configurable cache hours (default: 2)
• Onboarding wizard for first-time setup

Requirements

• WordPress 5.5+
• PHP 7.4+

Installation

1. Upload the barakah folder to /wp-content/plugins/
2. Activate the plugin from Plugins
3. Open Barakah admin menu and configure settings
4. Add shortcode to any page/post:

[barakah]

Shortcode

Use global settings:

[barakah]

Supported attributes:

• city (string)
• country (string)
• method (number/string; Aladhan method id)
• mode (dark or light)
• widget (full, prayer_times, ramadan, hadith, dua, date)
• columns (1 single-column, 2 two-column; applies to widget="full")

All available shortcode variants:

[barakah]
[barakah widget="full"]
[barakah widget="prayer_times"]
[barakah widget="ramadan"]
[barakah widget="hadith"]
[barakah widget="dua"]
[barakah widget="date"]

Common combinations:

[barakah city="London" country="UK"]
[barakah city="Istanbul" country="Turkey" method="13"]
[barakah mode="dark"]
[barakah mode="light"]
[barakah widget="prayer_times" mode="light"]
[barakah widget="ramadan" city="London" country="UK" method="2" mode="dark"]
[barakah widget="hadith" mode="light"]
[barakah widget="dua" mode="dark"]
[barakah widget="date" city="Dhaka" country="Bangladesh"]
[barakah widget="full" columns="1"]
[barakah widget="full" columns="2"]

Admin Settings Overview

• General: city, country, calculation method, cache duration
• Calendar & Timings: Hijri adjustment, Sehri/Iftar caution minutes
• Widget Display: layout, greetings, location change toggle
• Greeting Popup: enable, message, page scope, selected pages
• Sticky Bar: enable, position, theme, greeting text, page scope, selected pages
• Shortcode: quick usage examples

Greeting Popup (How To Use)

1. Go to Barakah -> Greeting Popup
2. Enable Greeting Popup
3. Set title/message
4. Choose where to show:
   • All pages
   • Specific pages only (then select pages)
5. Save settings

Popup behavior:

• Shows as an overlay on matching pages
• Visitor can close it with click outside or Esc
• Uses local storage cooldown to avoid showing repeatedly in a short period

Quick test link:

• Append ?barakah_test_popup=1 to any page URL
  Example: https://example.com/?barakah_test_popup=1

Sticky Prayer Bar (How To Use)

1. Go to Barakah -> Sticky Bar
2. Enable Sticky Prayer Bar
3. Configure:
   • Position: Header or Footer
   • Theme: Dark or Light
   • Greeting text
   • Scope: All pages or Specific pages only
4. Save settings

Sticky behavior:

• Appears collapsed on the right edge
• Auto-opens after a short delay, then can auto-collapse again
• Shows Sehri and Iftar based on your configured location and method
• If scope is Specific pages only, it only appears on selected pages

Caching

• Prayer times are cached with WordPress transients.
• Default cache duration: 2 hours.
• Cache is flushed when relevant settings change.

Security Notes

• Admin settings and onboarding are protected by capability checks and nonces.
• Plugin sanitizes and validates settings input.
• Frontend dynamic rendering escapes external/API-derived text before HTML insertion.

Project Structure

barakah/
  barakah.php
  readme.txt
  README.md
  assets/
    css/
      barakah.css
      barakah-admin.css
    js/
      barakah.js
      barakah-admin.js
  includes/
    admin.php
    onboarding.php
    shortcode.php
    class-barakah-api.php
  data/
    bangla_duas.json

Changelog

1.0.1

• Added five new shortcode widget variants:
  • prayer_times (full day prayer table)
  • ramadan (Sehri/Iftar essentials)
  • hadith (random hadith from API + fallback)
  • dua (random daily dua)
  • date (Islamic date + next prayer)
• Added compact widget card/table styles for dark and light modes

1.0.0

• Added settings tabs and refreshed admin UX
• Added onboarding wizard flow
• Added greeting popup page targeting
• Added sticky bar page targeting
• Added sticky bar delayed open + enhanced collapse/expand transitions
• Set sticky theme default to dark for new installs
• Updated cache default to 2 hours
• Improved frontend escaping for API-derived values
• Prevented duplicated dua interval timers on re-render
• Updated docs and release-readiness guidance

License

GPL-2.0+