Skip to content

README.md

Latest commit

 

History

History
181 lines (140 loc) · 4.31 KB

README.md

File metadata and controls

181 lines (140 loc) · 4.31 KB

WP Admin Panel Framework

A professional and modern framework for building WordPress admin panels with advanced data management capabilities. Built with clean architecture and developer experience in mind.

PHP Version WordPress Version License Author

Overview

WP Admin Panel Framework provides a robust foundation for creating professional WordPress plugins with modern admin interfaces. It eliminates the boilerplate code and common challenges in WordPress plugin development, allowing you to focus on your specific business logic.

✨ Core Features

🎯 Professional Admin Interface

  • Modern Dashboard

    • Clean and responsive design
    • Real-time data visualization
    • System status monitoring
    • Activity tracking
    • Quick action buttons

  • Advanced Data Management

    • AJAX-powered CRUD operations
    • Bulk actions support
    • Smart search & filtering
    • Sortable data tables
    • Built-in pagination
    • Data export/import

  • Flexible Settings System

    • Multiple field types
    • Real-time validation
    • Organized sections
    • Settings API integration
    • File upload handling

🔧 Developer Features

  • Clean Architecture

    • PSR-4 autoloading
    • Service-based design
    • Dependency injection
    • Event system
    • Extensive hooks

  • Database Layer

    • Migration system
    • Query Builder
    • Model abstraction
    • Relationship handling
    • Data validation

  • REST API

    • Versioned endpoints
    • Authentication
    • Rate limiting
    • Response caching
    • Swagger docs

🚀 Quick Start

Requirements

{
    "php": ">=7.4",
    "wordpress": ">=5.8",
    "mysql": ">=5.7"
}

Installation

  1. Clone the repository:
git clone https://github.com/3daghati/wp-admin-panel-framework.git
cd wp-admin-panel-framework
  1. Install dependencies:
composer install
  1. Activate in WordPress:
  • Move to wp-content/plugins/
  • Activate through WP Admin

📦 What's Included

wp-admin-panel-framework/
├── assets/               # Frontend assets
│   ├── css/             # Stylesheets
│   ├── js/              # JavaScript
│   └── vendor/          # 3rd party
├── src/                 # PHP source
│   ├── Admin/          # Admin UI
│   ├── Api/            # REST API
│   ├── Core/           # Core system
│   ├── Database/       # DB layer
│   └── Services/       # Business logic
└── templates/          # View files

💡 Usage Examples

Adding Admin Pages

add_action('custom_plugin_admin_menu', function($admin) {
    $admin->addPage([
        'title' => 'Custom Page',
        'slug' => 'custom-page',
        'icon' => 'dashicons-admin-generic'
    ]);
});

Using the Query Builder

$items = $queryBuilder
    ->select(['id', 'title', 'status'])
    ->where('status', 'active')
    ->orderBy('created_at', 'DESC')
    ->get();

REST API Endpoints

$router->get('/items', 'ItemController@index');
$router->post('/items', 'ItemController@store');
$router->put('/items/{id}', 'ItemController@update');

🛠️ Development

Building Assets

# Development
npm run dev

# Production
npm run build

# Watch
npm run watch

Running Tests

composer test

📚 Documentation

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

📝 License

This project is licensed under the GPL v2 or later - see the LICENSE file for details.

🌟 Support

⭐ Credits

Developed with ❤️ by 3daghati

If you find this framework helpful, please consider giving it a star ⭐