Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soberwp/intervention
WordPress plugin to configure wp-admin and application state using a single config file.
https://github.com/soberwp/intervention
dashboard intervention php woocommerce woocommerce-plugin wordpress wordpress-admin wordpress-api wordpress-development wordpress-php-library wordpress-plugin wp-admin
Last synced: 3 months ago
JSON representation
WordPress plugin to configure wp-admin and application state using a single config file.
- Host: GitHub
- URL: https://github.com/soberwp/intervention
- Owner: darrenjacoby
- License: mit
- Created: 2016-09-01T14:52:13.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-03-23T22:29:24.000Z (8 months ago)
- Last Synced: 2024-05-13T13:15:59.379Z (6 months ago)
- Topics: dashboard, intervention, php, woocommerce, woocommerce-plugin, wordpress, wordpress-admin, wordpress-api, wordpress-development, wordpress-php-library, wordpress-plugin, wp-admin
- Language: PHP
- Homepage:
- Size: 4.92 MB
- Stars: 631
- Watchers: 25
- Forks: 51
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
Easily customize [wp-admin](#admin) and configure [application](#application) options.
[View on WordPress.org](https://wordpress.org/plugins/intervention/)
## Installation
[Composer](https://getcomposer.org/)
```shell
$ composer require wpackagist-plugin/intervention
```
[WP-CLI](http://wp-cli.org/)
```shell
$ wp plugin install intervention --activate
```
#### Requirements
- [PHP](http://php.net/manual/en/install.php) >= 7.4.0
## Usage
Create `config/intervention.php` for Sage 10, or `intervention.php` inside your theme root folder and return an array.
```php
[
],
'wp-admin.$role|$username' => [
],
];
```
For the options, you can use [dot notatation, a standard array, or a combination](.github/config.md).
## Admin
Remove components from wp-admin.
Return `wp-admin.$role` or `wp-admin.$username`
- Support for multiple user roles using a pipe operator.
- `editor|author`
```php
[
'common.adminbar',
],
];
```
**User Roles**
- `all`
- `all-not-administrator` (shortcut alias)
- `administrator`
- `author`
- `editor`
- `contributor`
- `subscriber`
### Options
#### Login
- [login](.github/wp-admin/login.md)
#### Common
- [common.adminbar](.github/wp-admin/common.adminbar.md)
- [common.editor](.github/wp-admin/common.editor.md)
- [common.footer](.github/wp-admin/common.footer.md)
- [common.menu](.github/wp-admin/common.menu.md)
- [common.tabs](.github/wp-admin/common.tabs.md)
- [common.title-link](.github/wp-admin/common.title-link.md)
- [common.updates](.github/wp-admin/common.updates.md)
- [common.all.list](.github/wp-admin/common.all.list.md)
- [common.all.pagination](.github/wp-admin/common.all.pagination.md)
- [common.all.search](.github/wp-admin/common.all.search.md)
- [common.all.subsets](.github/wp-admin/common.all.subsets.md)
#### Dashboard
- [dashboard](.github/wp-admin/dashboard.md)
- [dashboard.home](.github/wp-admin/dashboard.home.md)
- [dashboard.updates](.github/wp-admin/dashboard.updates.md)
#### Posts
- [posts](.github/wp-admin/posts.md)
- [posts.all](.github/wp-admin/posts.all.md)
- [posts.item](.github/wp-admin/posts.item.md)
- [posts.categories.all](.github/wp-admin/posts.categories.all.md)
- [posts.categories.item](.github/wp-admin/posts.categories.item.md)
- [posts.tags.all](.github/wp-admin/posts.tags.all.md)
- [posts.tags.item](.github/wp-admin/posts.tags.item.md)
#### Media
- [media](.github/wp-admin/media.md)
- [media.all](.github/wp-admin/media.all.md)
- [media.add](.github/wp-admin/media.add.md)
#### Pages
- [pages](.github/wp-admin/pages.md)
- [pages.all](.github/wp-admin/pages.all.md)
- [pages.item](.github/wp-admin/pages.item.md)
#### Comments
- [comments](.github/wp-admin/comments.md)
- [comments.all](.github/wp-admin/comments.all.md)
#### Appearance
- [appearance](.github/wp-admin/appearance.md)
- [appearance.themes](.github/wp-admin/appearance.themes.md)
- [appearance.customize](.github/wp-admin/appearance.customize.md)
- [appearance.widgets](.github/wp-admin/appearance.widgets.md)
- [appearance.menus](.github/wp-admin/appearance.menus.md)
- [appearance.theme-editor](.github/wp-admin/appearance.theme-editor.md)
#### Plugins
- [plugins](.github/wp-admin/plugins.md)
- [plugins.all](.github/wp-admin/plugins.all.md)
- [plugins.add](.github/wp-admin/plugins.add.md)
- [plugins.plugin-editor](.github/wp-admin/plugins.plugin-editor.md)
#### Users
- [users](.github/wp-admin/users.md)
- [users.all](.github/wp-admin/users.all.md)
- [users.add](.github/wp-admin/users.add.md)
- [users.profile](.github/wp-admin/users.profile.md)
#### Tools
- [tools](.github/wp-admin/tools.md)
- [tools.available](.github/wp-admin/tools.available.md)
- [tools.import](.github/wp-admin/tools.import.md)
- [tools.export](.github/wp-admin/tools.export.md)
- [tools.site-health](.github/wp-admin/tools.site-health.md)
- [tools.export-personal-data](.github/wp-admin/tools.export-personal-data.md)
- [tools.erase-personal-data](.github/wp-admin/tools.erase-personal-data.md)
#### Settings
- [settings](.github/wp-admin/settings.md)
- [settings.general](.github/wp-admin/settings.general.md)
- [settings.writing](.github/wp-admin/settings.writing.md)
- [settings.reading](.github/wp-admin/settings.reading.md)
- [settings.discussion](.github/wp-admin/settings.discussion.md)
- [settings.media](.github/wp-admin/settings.media.md)
- [settings.permalinks](.github/wp-admin/settings.permalinks.md)
## Application
Set application options.
- Options are automatically changed to read only fields in `wp-admin`.
- Options can be placed under version control.
Return `application`.
Tip: automate exporting a config file from the database using Tools→Intervention in the WordPress admin.
```php
[
'general' => [
'tagline' => 'Intervention Example',
'wp-address' => 'https://example.com/wp',
'site-address' => 'https://example.com',
'admin-email' => '[email protected]',
'membership' => false,
'default-role' => 'editor',
'language' => 'en_US',
'timezone' => 'Africa/Johannesburg',
'date-format' => 'F j Y',
'time-format' => 'g:i a',
'week-starts' => 'Mon',
],
],
];
```
### Options
- [theme](.github/application/theme.md)
- [posts/posttypes](.github/application/posts.md)
- [taxonomies](.github/application/taxonomies.md)
- [menus](.github/application/menus.md)
- [plugins](.github/application/plugins.md)
- [general](.github/application/general.md)
- [reading](.github/application/reading.md)
- [writing](.github/application/writing.md)
- [discussion](.github/application/discussion.md)
- [media](.github/application/media.md)
- [permalinks](.github/application/permalinks.md)
- [privacy](.github/application/privacy.md)
### Quick Reference
- [Full configuration options](.github/application-options.md)
- [Full configuration example](.github/application-example.md)
- [Register custom posttype](.github/application/posts.md#register)
- [Register custom taxonomy](.github/application/taxonomies.md#register)
- [Register custom image sizes](.github/application/media.md#image-sizes)
- [Register custom nav menu](.github/application/menus.md#register)
- [Remove comments](.github/application/discussion.md#remove)
- [Remove posttype](.github/application/posts.md#remove)
- [Remove taxonomy](.github/application/taxonomies.md#remove)
- [Remove image size](.github/application/media.md#image-sizes)
- [Remove emoji](.github/application/writing.md)
- [Remove attachments](.github/application/posts.md#remove)
- [Enable custom media/mime types](.github/application/media.md#mime-types)
### Connect
- Twitter: [@withjacoby](https://twitter.com/withjacoby)