considbrs-webdev/pitea-customisation

Custom functionality and modifications for the Pitea WordPress installation

Maintainers

Package info

github.com/Considbrs-Webdev/pitea-customisation

Type:wordpress-plugin

pkg:composer/considbrs-webdev/pitea-customisation

Statistics

Installs: 16

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

dev-main 2026-01-27 14:41 UTC

README

A WordPress plugin for custom functionality and modifications for the Pitea WordPress installation.

Features

  • Modular PHP architecture with Composer autoloading
  • Vite for modern CSS and JavaScript building
  • SCSS support with variables and mixins
  • Separate frontend and admin asset bundles

Requirements

  • PHP 8.0+
  • Node.js 18+
  • Composer

Installation

  1. Navigate to the plugin directory:

    cd wp-content/plugins/pitea-customisation
  2. Install PHP dependencies:

    composer install
  3. Install Node.js dependencies:

    npm install
  4. Build assets:

    npm run build
  5. Activate the plugin in WordPress admin.

Development

Watch for changes

npm run dev

Or for production watch:

npm run watch

Build for production

npm run build

Adding Custom Classes

  1. Create a new PHP class in source/php/Customisations/:

    <?php
    
    namespace PiteaCustomisation\Customisations;
    
    class MyCustomClass
    {
        public function __construct()
        {
            // Your hooks and initialization here
        }
    }
  2. Register the class in source/php/App.php:

    private function registerInstances(): void
    {
        $classes = [
            Customisations\IconReplacer::class,
            Customisations\MyCustomClass::class, // Add your class here
        ];
        // ...
    }
  3. Run composer dump-autoload to update the autoloader.

Directory Structure

pitea-customisation/
├── dist/                    # Built assets (generated)
├── source/
│   ├── js/
│   │   ├── main.js          # Frontend JavaScript entry
│   │   └── admin.js         # Admin JavaScript entry
│   ├── php/
│   │   ├── App.php          # Main plugin class
│   │   └── Customisations/  # Custom functionality classes
│   │       └── IconReplacer.php
│   └── sass/
│       ├── style.scss       # Frontend styles entry
│       ├── admin.scss       # Admin styles entry
│       └── abstracts/       # Variables, mixins, etc.
├── composer.json
├── package.json
├── vite.config.js
└── pitea-customisation.php  # Main plugin file

License

MIT