magdev
d36b6c3dd9
All checks were successful
Create Release Package / build-release (push) Successful in 1m21s
- Main plugin file with PHP 8.3+ and WordPress 6.0+ version checks - Plugin singleton class with admin menu and settings pages - License Manager integration with SecureLicenseClient - License settings tab with validation and activation - Admin CSS and JavaScript for license management - Gitea CI/CD workflow for automated releases - Documentation: README.md, PLAN.md, CHANGELOG.md, CLAUDE.md - Composer dependencies: Twig 3.0, license client - Git submodule for wc-licensed-product-client library Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
161 lines
4.4 KiB
Markdown
161 lines
4.4 KiB
Markdown
# WP BnB Management
|
|
|
|
A comprehensive Bed & Breakfast management system for WordPress. Manage buildings, rooms, bookings, and guests all within your WordPress admin.
|
|
|
|
## Description
|
|
|
|
WP BnB Management enables WordPress to act as a full management system for B&B hosts. It handles multiple buildings with multiple rooms each, bookings, and guest data required for room rentals.
|
|
|
|
### Key Features
|
|
|
|
- **Multi-Property Support**: Manage multiple buildings, each with multiple rooms
|
|
- **Flexible Pricing**: Configure short-term (nights), mid-term (weeks), and long-term (months) pricing
|
|
- **Booking Management**: Track reservations from inquiry to checkout
|
|
- **Guest Management**: Store guest information securely with GDPR compliance
|
|
- **Additional Services**: Offer extras like breakfast, parking, or tours
|
|
- **Frontend Integration**: Gutenberg blocks, widgets, and shortcodes
|
|
- **Contact Form 7 Integration**: Accept booking requests through forms
|
|
|
|
### Requirements
|
|
|
|
- WordPress 6.0 or higher
|
|
- PHP 8.3 or higher
|
|
- Valid license key
|
|
|
|
## Installation
|
|
|
|
1. Download the latest release from the [releases page](https://src.bundespruefstelle.ch/magdev/wp-bnb/releases)
|
|
2. Upload the plugin to your `/wp-content/plugins/` directory
|
|
3. Activate the plugin through the 'Plugins' menu in WordPress
|
|
4. Go to **WP BnB → Settings → License** to enter your license key
|
|
5. Configure your business settings under **WP BnB → Settings**
|
|
|
|
## Configuration
|
|
|
|
### License Activation
|
|
|
|
1. Navigate to **WP BnB → Settings → License**
|
|
2. Enter your License Server URL
|
|
3. Enter your License Key (from purchase confirmation)
|
|
4. Enter the Server Secret (from purchase confirmation)
|
|
5. Click **Activate License**
|
|
|
|
### General Settings
|
|
|
|
- **Business Name**: Your B&B business name
|
|
- **Currency**: Select your preferred currency (CHF, EUR, USD, GBP)
|
|
|
|
## Usage
|
|
|
|
### Managing Buildings
|
|
|
|
1. Go to **WP BnB → Buildings**
|
|
2. Click **Add New**
|
|
3. Enter building details (name, address, description)
|
|
4. Add featured image
|
|
5. Publish
|
|
|
|
### Managing Rooms
|
|
|
|
1. Go to **WP BnB → Rooms**
|
|
2. Click **Add New**
|
|
3. Select the parent building
|
|
4. Configure room details and pricing
|
|
5. Add amenities and room type
|
|
6. Publish
|
|
|
|
### Managing Bookings
|
|
|
|
1. Go to **WP BnB → Bookings**
|
|
2. View and manage all reservations
|
|
3. Update booking status as guests progress
|
|
|
|
### Managing Guests
|
|
|
|
1. Go to **WP BnB → Guests**
|
|
2. View guest records and booking history
|
|
3. Manage guest information
|
|
|
|
## Shortcodes
|
|
|
|
Display buildings and rooms on your site using shortcodes:
|
|
|
|
```txt
|
|
[wp_bnb_buildings]
|
|
[wp_bnb_rooms building="123"]
|
|
[wp_bnb_room_search]
|
|
```
|
|
|
|
## Gutenberg Blocks
|
|
|
|
The following blocks are available in the block editor:
|
|
|
|
- **Building** - Display a single building
|
|
- **Room** - Display a single room
|
|
- **Room Search** - Search and filter rooms
|
|
- **Booking Form** - Accept booking requests
|
|
|
|
## Widgets
|
|
|
|
Available sidebar widgets:
|
|
|
|
- **Similar Rooms** - Show rooms similar to the current one
|
|
- **Building Rooms** - List all rooms in a building
|
|
|
|
## Hooks and Filters
|
|
|
|
Developers can customize behavior using these hooks:
|
|
|
|
```php
|
|
// Modify price calculation
|
|
add_filter( 'wp_bnb_calculate_price', function( $price, $room_id, $dates ) {
|
|
// Custom pricing logic
|
|
return $price;
|
|
}, 10, 3 );
|
|
|
|
// Before booking creation
|
|
add_action( 'wp_bnb_before_booking_create', function( $booking_data ) {
|
|
// Custom validation or logging
|
|
} );
|
|
```
|
|
|
|
## Frequently Asked Questions
|
|
|
|
### Do I need a license to use this plugin?
|
|
|
|
Yes, a valid license is required to use the frontend features. The admin functionality works without a license for evaluation purposes.
|
|
|
|
### Can I manage multiple properties?
|
|
|
|
Yes, you can create unlimited buildings and rooms.
|
|
|
|
### Is the plugin GDPR compliant?
|
|
|
|
Yes, guest data can be exported and deleted on request, and consent is tracked appropriately.
|
|
|
|
### Does it integrate with WooCommerce?
|
|
|
|
WooCommerce integration for payments is planned for a future release.
|
|
|
|
## Changelog
|
|
|
|
See [CHANGELOG.md](CHANGELOG.md) for a detailed list of changes.
|
|
|
|
## Support
|
|
|
|
For support, please create an issue at:
|
|
<https://src.bundespruefstelle.ch/magdev/wp-bnb/issues>
|
|
|
|
## Author
|
|
|
|
**Marco Graetsch**
|
|
|
|
- Website: <https://src.bundespruefstelle.ch/magdev>
|
|
- Email: <magdev3.0@gmail.com>
|
|
|
|
## License
|
|
|
|
GPL-2.0-or-later
|
|
|
|
This plugin is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or any later version.
|