wp-bnb/CLAUDE.md

WordPress BnB Management

Author: Marco Graetsch Author URL: https://src.bundespruefstelle.ch/magdev Author Email: magdev3.0@gmail.com Repository URL: https://src.bundespruefstelle.ch/magdev/wp-bnb Issues URL: https://src.bundespruefstelle.ch/magdev/wp-bnb/issues

Project Overview

This plugin enables Wordpress to act as an full management system for BnB hosts. It can handle multiple buildings with multiple rooms each, the booking of the rooms and the guests data required for renting a room. It also can handle different prices for short-, mid- and longterm rentings, configurable by the owner. In future versions - but not yet - there could be an optional possibility to pay the bookings upfront employing parts of WooCommerce, especially the payment and invoicing functions. Each Booking can have multiple additional Service options with either a price tag or can be marked as included.

Features

• Full data definition for the owner of the business
• Custom Post-types for Buildings and Rooms, while Rooms must be assigned to a building.
• Multiple pricing classes for short- (days), mid- (weeks) and longterm (months) bookings.
• Fully integrated using Gutenberg-Blocks, Widgets and Shortcodes
• Integrates with CF7 for forms (more Form plugins my follow in future versions)

Frontend

• Advanced Search and filtering for rooms, taking availability into account
• Gutenberg-Blocks: Building, Room, Booking
• Sidebar Widgets: Similar Rooms, Buildings
• Shortcodes: Similar Rooms, Buildings

Administration

• Dedicated pages for management of buildings, rooms, guests and bookings
• Dashboard with relevant statistics

Key Fact: 100% AI-Generated

This project is proudly "vibe-coded" using Claude.AI - the entire codebase was created through AI assistance.

Temporary Roadmap

Note for AI Assistants: Clean this section after the specific features are done or new releases are made. Effective changes are tracked in CHANGELOG.md. Do not add completed versions here - document them in the Session History section at the end of this file.

Version 0.1.0 - Core Data Structures

• Custom Post Type: Buildings (address, contact, description, images)
• Custom Post Type: Rooms (building reference, capacity, amenities)
• Custom Taxonomy: Room Types (Standard, Suite, Family, etc.)
• Custom Taxonomy: Amenities (WiFi, Parking, Breakfast, etc.)
• Gutenberg blocks for Buildings and Rooms
• See PLAN.md for full implementation roadmap

Technical Stack

• Language: PHP 8.3.x
• PHP-Standards: PSR-4
• Framework: Latest WordPress Plugin API
• E-commerce: WooCommerce 10.0+ (optional, not used yet)
• Template Engine: Twig 3.0 (via Composer)
• Wordpress Form-Plugin: CF7 (for Bookings et al)
• Wordpress Base Theme twentytwentyfive
• Frontend: Vanilla JavaScript
• Styling: Custom CSS
• Dependency Management: Composer
• Internationalization: WordPress i18n (.pot/.po/.mo files)
• Canonical Plugin Name: wp-bnb
• License Client: magdev/wc-licensed-product-client

Security Best Practices

• All user inputs are sanitized (integers for quantities/prices)
• Nonce verification on form submissions
• Output escaping in templates (esc_attr, esc_html, esc_js)
• Direct file access prevention via ABSPATH check
• XSS-safe DOM construction in JavaScript (no innerHTML with user data)
• SQL injection prevention using $wpdb->prepare() throughout

Translation Ready

All user-facing strings use:

__('Text to translate', 'wp-bnb')
_e('Text to translate', 'wp-bnb')

Text domain: wp-bnb

Translation Template

• Base .pot file created: languages/wp-bnb.pot
• Ready for translation to any locale
• All translatable strings properly marked with text domain

Available Translations

• en_US - English (United States) [base language - .pot template]
• de_CH - German (Switzerland, formal)

To compile translations to .mo files for production:

for po in languages/*.po; do msgfmt -o "${po%.po}.mo" "$po"; done

Create releases

• The vendor/ directory MUST be included in releases (Dependencies required for runtime)
• CRITICAL: Build vendor/ for the MINIMUM supported PHP version, not the development version
  • Use composer config platform.php 8.3.0 before building release packages
  • Run composer update --no-dev --optimize-autoloader to rebuild dependencies
• CRITICAL: WordPress requires plugins in a subdirectory structure
  • Run zip from the plugins/ parent directory, NOT from within the plugin directory
  • Package must extract to wp-bnb/ subdirectory with main file at wp-bnb/wp-bnb.php
  • Correct command: cd /wp-content/plugins/ && zip -r wp-bnb/releases/wp-bnb-x.x.x.zip wp-bnb ...
  • Wrong: Running zip from inside the plugin directory creates files at root level
• CRITICAL: Exclude symlinks explicitly - zip follows symlinks by default
  • Always use -x "wp-bnb/wp-core" -x "wp-bnb/wp-core/*" -x "wp-bnb/wp-plugins" -x "wp-bnb/wp-plugins/*" to exclude development symlinks
  • Otherwise the entire linked directory contents will be included in the package
• Exclusion patterns must match the relative path structure used in zip command
• Always verify the package structure with unzip -l before distribution
  • Check all files are prefixed with wp-bnb/
  • Verify main file is at wp-bnb/wp-bnb.php
  • Check for duplicate entries (indicates multiple builds in same archive)
• Test installation on the minimum supported PHP version before final deployment
• Releases are stored in releases/ including checksums
• Track release changes in a single CHANGELOG.md file
• Bump the version number to either bugfix release versions or on new features minor release versions
• CRITICAL: WordPress reads version from TWO places - BOTH must be updated:
  1. Plugin header comment Version: x.x.x - WordPress uses THIS for admin display
  2. PHP constant WP_BNB_VERSION (line ~28) - Used internally by the plugin
  • If only the constant is updated, WordPress will show the old version in Plugins list

Important Git Notes:

• Default branch while development is dev
• Create releases from branch main after merging branch dev
• Tags should use format vX.X.X (e.g., v1.1.22), start with v0.0.1
• Use annotated tags (-a) not lightweight tags
• Commit messages should follow the established format with Claude Code attribution
• .claude/settings.local.json changes are typically local-only (stash before rebasing)

What Gets Released

• All plugin source files
• Compiled vendor dependencies
• Translation files (.mo compiled from .po)
• Assets (CSS, JS)
• Documentation (README, CHANGELOG, etc.)

What's Excluded

• Git metadata (.git/)
• Development files (.vscode/, .claude/, CLAUDE.md, wp-core, wp-plugins)
• Logs and cache files
• Previous releases
• composer.lock (but vendor/ is included)

---

For AI Assistants:

When starting a new session on this project:

1. Read this CLAUDE.md file first
2. Semantic versioning follows the MAJOR.MINOR.BUGFIX pattern
3. Check git log for recent changes
4. Verify you're on the dev branch before making changes
5. Run composer install if vendor/ is missing
6. Test changes before committing
7. Follow commit message format with Claude Code attribution
8. Update this session history section with learnings
9. Never commit backup files (*.po~, *.bak, etc.) - check git status before committing
10. Follow markdown linting rules (see below)

Always refer to this document when starting work on this project.

Markdown Linting Rules

When editing CLAUDE.md or other markdown files, follow these rules to avoid linting errors:

1. MD031 - Blank lines around fenced code blocks: Always add a blank line before and after fenced code blocks, even when they follow list items. Example of correct format:

   • Item label:

     (blank line here) ```php code example ``` (blank line here)

2. MD056 - Table column count: Table separators must have matching column counts and proper spacing. Use consistent dash lengths that match column header widths.

3. MD009 - No trailing spaces: Remove trailing whitespace from lines

4. MD012 - No multiple consecutive blank lines: Use only single blank lines between sections

5. MD040 - Fenced code blocks should have a language specified: Always add a language identifier to code blocks (e.g., txt, bash, php). For shortcode examples, use txt.

6. MD032 - Lists should be surrounded by blank lines: Add a blank line before AND after list blocks, including after bold labels like **Attributes:**.

7. MD034 - Bare URLs: Wrap URLs in angle brackets (e.g., <https://example.com>) or use markdown link syntax [text](url).

8. Author section formatting: Use a heading (### Name) instead of bold (**Name**) for the author name to maintain consistent document structure.

Project Architecture

Directory Structure

wp-bnb/
├── wp-bnb.php              # Main plugin file (entry point)
├── composer.json           # Composer configuration
├── composer.lock           # Dependency lock file
├── CHANGELOG.md            # Version history
├── CLAUDE.md               # AI assistant documentation
├── PLAN.md                 # Implementation roadmap
├── README.md               # User documentation
├── .editorconfig           # Editor configuration
├── .gitignore              # Git ignore patterns
├── .gitmodules             # Git submodule configuration
├── .gitea/
│   └── workflows/
│       └── release.yml     # CI/CD release pipeline
├── src/                    # PHP source code (PSR-4: Magdev\WpBnb)
│   ├── Plugin.php          # Main plugin singleton
│   └── License/
│       └── Manager.php     # License management
├── lib/                    # Git submodules
│   └── wc-licensed-product-client/  # License client library
├── vendor/                 # Composer dependencies (auto-generated)
├── assets/
│   ├── css/
│   │   ├── admin.css       # Admin styles
│   │   └── frontend.css    # Frontend styles
│   └── js/
│       ├── admin.js        # Admin scripts
│       └── frontend.js     # Frontend scripts
├── templates/              # Twig templates (future)
├── languages/              # Translation files (future)
└── releases/               # Release packages (git-ignored)

Implementation Details

Main Plugin File (wp-bnb.php)

• Plugin header with metadata
• Version constants: WP_BNB_VERSION, WP_BNB_PATH, WP_BNB_URL
• PHP 8.3+ and WordPress 6.0+ version checks
• Composer autoloader loading
• Activation/deactivation hooks

Plugin Class (src/Plugin.php)

• Singleton pattern for global access
• Twig environment initialization
• Admin menu registration (Dashboard, Settings)
• Settings page with tabs (General, License)
• Asset enqueuing (admin and frontend)
• License-gated frontend components

License Manager (src/License/Manager.php)

• Integration with SecureLicenseClient or LicenseClient
• Option storage for license key, server URL, server secret
• License validation with domain binding
• License activation with domain
• Status caching (24-hour transient)
• AJAX handlers for admin operations
• Exception handling for all license states

Frontend Restriction Logic

// In Plugin::init_components()
if ( ! is_admin() && LicenseManager::is_license_valid() ) {
    $this->init_frontend();  // Load frontend components
}

Admin features always work; frontend requires valid license.

---

Session History

2026-01-31 - Version 0.0.1 (Initial Setup)

Completed:

• Explored existing project structure (configuration files only)
• Added git submodule for wc-licensed-product-client at lib/wc-licensed-product-client
• Installed Composer dependencies (Twig 3.0, license client, Symfony HttpClient)
• Studied license client documentation and wp-fedistream implementation
• Created main plugin file wp-bnb.php with version checks
• Created Plugin singleton class with admin integration
• Created License\Manager with SecureLicenseClient integration
• Implemented license settings page with validation/activation buttons
• Created admin CSS and JavaScript for license management
• Created Gitea CI/CD pipeline at .gitea/workflows/release.yml
• Created PLAN.md with full implementation roadmap (8 phases)
• Created README.md with user documentation
• Created CHANGELOG.md following Keep a Changelog format
• Updated CLAUDE.md with architecture details

Learnings:

• License client requires checkout of specific tag (v0.2.2) for Composer path repository
• Relative URL in .gitmodules (../wc-licensed-product-client.git) works for Gitea hosting
• wp-fedistream pattern: LicenseManager::is_license_valid() guards frontend initialization
• Settings page uses tabs with nonce-protected form submission
• AJAX handlers require check_ajax_referer() and current_user_can() checks
• CI/CD workflow excludes lib/ directory but includes vendor/ in releases