https://github.com/mystroken/wordpruss

:candy: :chocolate_bar: A reusable set of clean and "beautified" PHP classes that wrap WordPress features.
https://github.com/mystroken/wordpruss

php wordpress wordpress-development

Last synced: 11 months ago
JSON representation

:candy: :chocolate_bar: A reusable set of clean and "beautified" PHP classes that wrap WordPress features.

• Host: GitHub
• URL: https://github.com/mystroken/wordpruss
• Owner: mystroken
• License: mit
• Created: 2017-06-05T06:07:15.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-08-15T09:31:13.000Z (almost 9 years ago)
• Last Synced: 2024-11-15T03:09:00.826Z (over 1 year ago)
• Topics: php, wordpress, wordpress-development
• Language: PHP
• Homepage:
• Size: 273 KB
• Stars: 1
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# WordPruss

[![Build Status](https://travis-ci.org/CompanionsOfWP/wordpruss.svg?branch=master)](https://travis-ci.org/CompanionsOfWP/wordpruss)

[![Total Downloads](https://poser.pugx.org/wordpruss/wordpruss/downloads)](https://packagist.org/packages/wordpruss/wordpruss)

[![License](https://poser.pugx.org/wordpruss/wordpruss/license)](https://packagist.org/packages/wordpruss/wordpruss)

WordPruss is a reusable set of clean PHP classes that wrap WordPress functions for a fastly plugin or theme development.

## Installation

It's recommended that you use [Composer](https://getcomposer.org/) to install WordPruss.

```bash

$ composer require wordpruss/wordpruss "dev-master"

```

This will install WordPruss and all required dependencies. WordPruss requires PHP 5.6 or newer.

## Usage

Here is a Basic Example of the library usage:

```php

 'My Plugin Name',

    'slug' => 'my_plugin_name'

]);

// Create a panel for the menu

$adminPanel = new Panel([

    'title' => 'Plugin Name - Welcome to the settings page',

    'role' => 'manage_options',

    'callback' => function() {

        echo '
Hello World !
';

    }

]);


$adminMenu

// Links panel to the menu

    ->setPanel($adminPanel)

// Adds the menu to WordPress admin menus list

    ->attach();

```

For more information on how to configure your web server, see the [Documentation](https://mystroken.github.io/wordpruss/).

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security

If you discover security related issues, please email mystroken@gmail.com or use the issue tracker.

## License

WordPruss is an open-sourced library licensed under the MIT license. See [License File](LICENSE.md) for more information.