Invest Off Plan Plugin

Description

The Invest Off Plan plugin is a custom WordPress plugin designed to rate websites. It provides a robust and flexible framework for managing website ratings with features like configuration management, operations handling, and controller initialization.

Features

• Website rating functionality.
• Modular architecture for easy maintenance.
• Composer integration for dependency management.

Installation

1. Clone the repository to your WordPress plugins directory:

   git clone https://github.com/SubhodeepJha/invest-off-plan

2. Activate the plugin from the WordPress admin dashboard.

Requirements

• PHP 7.4 or higher
• Composer
• WordPress 5.0 or higher

Usage

1. Configure the plugin settings in the WordPress admin dashboard.
2. Use the provided shortcodes or API endpoints to integrate the rating functionality into your website.

Template override (single-offplan)

You can override the plugin single project template from your active theme. Place a file at:

wp-content/themes/your-theme/invest-off-plan/single-offplan.php

Copy the plugin template markup from core/View/frontend/single-offplan.php into your theme file and modify as needed.

Programmatic override via filter:

add_filter('invest_offplan_single_template', function($template_path, $project_id) {
   // Return a custom path inside the active theme or plugin
   return get_stylesheet_directory() . '/my-overrides/offplan-single.php';
}, 10, 2);

Shortcode example (listings)

Place the shortcode on any page or post to render the listing:

[OFFPLAN_LISTINGS]

Shortcodes

1. OFFPLAN_LISTINGS

Renders the off-plan listings. This shortcode supports several optional query/filter parameters — pass them via a filter or modify the controller if you need dynamic values from the page. Current defaults used by the controller:

• lang: 'en'
• filter: 'yes'
• objects_per_page: 4
• page: 1
• unit: 'foot'
• object_status: 'active'

Usage:

[OFFPLAN_LISTINGS]

To change defaults programmatically you can filter the controller output or modify the controller method offplan_listings().

2. ALL_DEVELOPERS

Renders a grid of developers. Shortcode accepts attributes (all optional):

• cursor: string (default '1') — API cursor for pagination
• limit: integer (default 6) — number of items to fetch

Usage examples:

[ALL_DEVELOPERS]

With attributes:

[ALL_DEVELOPERS cursor="2" limit="12"]

The controller merges shortcode attributes with defaults and passes them to the API client.

Notes:

• If the theme override file exists it will be used automatically.
• If you change rewrite rules (add/remove endpoints) flush permalinks via Settings → Permalinks or call flush_rewrite_rules() on activation.

Got it 👍 Here’s a short version you can copy-paste directly into your plugin’s readme.txt:

---

Versioning

We follow Semantic Versioning (SemVer):

MAJOR.MINOR.PATCH[-label]

• MAJOR → Breaking changes (1.0.0 → 2.0.0)
• MINOR → New features, backward compatible (1.0.0 → 1.1.0)
• PATCH → Bug fixes (1.0.0 → 1.0.1)

Development Labels

• -dev → Work in progress
• -alpha → Early testing
• -beta → Feature complete, may contain bugs
• -rc → Release candidate

Example lifecycle: 0.1.0-dev → 0.1.0-beta → 0.1.0-rc1 → 0.1.0 → 0.1.1 → 0.2.0 → 1.0.0

---

Want me to also make a 1-line versioning rule (super short, just 1-2 lines) you can drop at the end of your readme?

Security and Maintenance

• Follow best practices for WordPress plugin development to maintain security and performance.

License

This plugin is licensed under the MIT License.

Author

Developed by SkyNet.