Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/italystrap/settings
https://github.com/italystrap/settings
wordpress wordpress-php-library
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/italystrap/settings
- Owner: ItalyStrap
- License: mit
- Created: 2019-12-26T18:33:53.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-29T08:14:20.000Z (over 4 years ago)
- Last Synced: 2024-11-25T10:02:09.302Z (about 1 month ago)
- Topics: wordpress, wordpress-php-library
- Language: PHP
- Homepage:
- Size: 550 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ItalyStrap Settings API
[](https://travis-ci.org/ItalyStrap/settings)
[](https://packagist.org/packages/italystrap/settings)
[](https://packagist.org/packages/italystrap/settings)
[](https://packagist.org/packages/italystrap/settings)
[](https://packagist.org/packages/italystrap/settings)
WordPress Settings API the OOP way
**Work in progress:** the project is currently in beta until considered viable. Until a 1.0.0 release the code in this repository is not stable. Expect changes breaking backward compatibility between minor versions (0.1.x -> 0.2.x).
## Table Of Contents
* [Installation](#installation)
* [Basic Usage](#basic-usage)
* [Advanced Usage](#advanced-usage)
* [Contributing](#contributing)
* [License](#license)
## Installation
The best way to use this package is through Composer:
```CMD
composer require italystrap/settings
```
This package adheres to the [SemVer](http://semver.org/) specification and will be fully backward compatible between minor versions.
## Idea of the structure
* Plugin MUST HAVE one options storage (call get_option one time and get all the options)
* Plugin COULD HAVE one or more settings pages with its own menu link (Parent and/or Child)
* Settings page COULD HAVE 0, 1 or many section
* Sections MUST HAVE at least 1 field
* Sections ARE separated by tabs
* Plugin COULD HAVE 0, 1 or more links in the plugins.php page
## Basic Usage
The simpler way to use it is to instantiate the Builder and add the stuff you need.
You can find last updated code in the [example.php](example.php) file
```php
use ItalyStrap\Settings\Page;
use ItalyStrap\Settings\SettingsBuilder;
$text_domain = 'ItalyStrap';
$option_name = 'italystrap';
$settings_config = \ItalyStrap\Config\ConfigFactory::make(
require __DIR__ . '/tests/_data/fixtures/config/settings.php'
);
// Initialize the builder
$settings = new SettingsBuilder(
$option_name,
ITALYSTRAP_BASENAME,
ITALYSTRAP_FILE
);
// You can add configuration via the \ItalyStrap\Config\ConfigFactory::class
$settings->addPage(
$settings_config->get( 'page' ),
$settings_config->get( 'sections' )
);
// Ora manually
// The section parameter is optional
// Not every page need a section with fields
// For example in a docs page
// Manu title and slug are mandatory
$settings->addPage(
[
Page::PARENT => 'italystrap-dashboard',
Page::PAGE_TITLE => \__( 'Dashboard 2', 'italystrap' ),
Page::MENU_TITLE => \__( 'Child1', 'italystrap' ),
Page::SLUG => 'slug-for-child-page',
Page::VIEW => __DIR__ . '/tests/_data/fixtures/view/empty_form.php',
]
);
// You can also add a sub page either for you parent page or for the WP admin pages
$settings->addPage(
[
Page::PARENT => 'options-general.php',
// Page::PAGE_TITLE => \__( 'ItalyStrap Dashboard 2', 'italystrap' ),
Page::MENU_TITLE => \__( 'Child-general', 'italystrap' ),
Page::SLUG => 'slug-for-child-general',
Page::VIEW => __DIR__ . '/tests/_data/fixtures/view/empty_form.php',
]
);
// You can also add a link to the plugins.php page in your plugin link for activation
// For example if you want to add an external link to your docs.
$settings->addCustomPluginLink(
'key-for-css',
'http://localhost.com',
'Custom',
[ 'target' => '_blank' ]
);
// After you added pages[?section] and/or link call the build() method.
$settings->build();
```
## Advanced Usage
> TODO
## Contributing
All feedback / bug reports / pull requests are welcome.
## License
Copyright (c) 2019 Enea Overclokk, ItalyStrap
This code is licensed under the [MIT](LICENSE).
## Credits
> TODO