https://github.com/apalfrey/construct-wp

ConstructWP is a framework system to allow for easier development as well as useful tools and addons.
https://github.com/apalfrey/construct-wp

Last synced: about 1 month ago
JSON representation

ConstructWP is a framework system to allow for easier development as well as useful tools and addons.

• Host: GitHub
• URL: https://github.com/apalfrey/construct-wp
• Owner: apalfrey
• License: gpl-2.0
• Created: 2023-09-07T14:30:37.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-10-22T19:50:11.000Z (about 1 year ago)
• Last Synced: 2024-04-14T02:59:22.690Z (8 months ago)
• Language: PHP
• Homepage:
• Size: 1.4 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ConstructWP

## ConstructWP is a framework system to allow for easier development as well as useful tools and addons.

## Features

* Email system with templates that can be created in the WP Admin dashboard

* Ability to autoload theme CSS & JS files if they exist

  * `assets/css/[THEME-SLUG].css`

  * `assets/js/[THEME-SLUG].js`

  * `assets/css/[TEMPLATE-FILE-NAME].css`

  * `assets/js/[TEMPLATE-FILE-NAME].js`

* Ability to autoload theme models and template controllers

  * Models located in `/models`

  * Controllers located in `/controllers` using the same name as the template file

* Additional menu item options to further customise a menu

* A custom navwalker based on Bootstrap 5

* Various settings including optimisation and access restriction

* A variety of useful utilities for use during theme or plugin development

* More to come!

## Installation

1. Download ConstructWP from [Github](https://github.com/apalfrey/construct-wp)

2. Upload `construct-wp` to the `/wp-content/plugins/` directory

3. Activate the plugin through the `Plugins` menu in WordPress

4. Use the Settings->ConstructWP screen to configure the plugin

## Frequently Asked Questions

### Where do I put my controllers?

Controllers follow the same path and file name as their respective templates, located in the `controller` directory. e.g. For the `author.php` template, the controller will be `controller/author.php` while the controller for the `templates/template-profile.php` template will by `controller/templates/template-profile.php`

### Can I auto-initiate my models and controllers?

Yes! Models and controllers can be auto-initiated if the class has a static method called `init`.