Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/10quality/wpmvc-addon-status
WordPress MVC add-on that adds a system status report and a log viewer option in admin dashboard.
https://github.com/10quality/wpmvc-addon-status
Last synced: 5 days ago
JSON representation
WordPress MVC add-on that adds a system status report and a log viewer option in admin dashboard.
- Host: GitHub
- URL: https://github.com/10quality/wpmvc-addon-status
- Owner: 10quality
- License: mit
- Created: 2020-07-22T00:37:21.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-10T23:04:02.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T02:19:23.571Z (about 1 month ago)
- Language: PHP
- Homepage:
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Status Addon (for Wordpress MVC)
[](https://packagist.org/packages/10quality/wpmvc-addon-status)
[](https://packagist.org/packages/10quality/wpmvc-addon-status)
[](https://packagist.org/packages/10quality/wpmvc-addon-status)
Add-on for [WordPress MVC](http://www.wordpress-mvc.com/).
The add-on will add a "System Status" option inside WordPress admin dashboard, allowing for administrator to see the system status and log files.
Features:
* System status (WP, PHP and DB versions).
* Easy JSON export.
* WordPress MVC log file viewer.
* Flush WordPress MVC cache.
## Install and Configuration
To install, use the following composer command:
```bash
composer require 10quality/wpmvc-addon-status
```
To configure the add-on, simply add it to your projects add-ons list at `[project]/app/Config/app.php`:
```php
'addons' => [
'WPMVC\Addons\Status\StatusAddon',
],
```
## Hooks
You can add custom status information and sections.
### wpmvc_addon_status_sections
Filter `wpmvc_addon_status_sections` allows to add new sections to the system status report, example:
```php
add_filter( 'wpmvc_addon_status_sections', function( $sections ) {
$sections['my-plugin'] = __( 'My Plugin', 'my-domain' );
return $sections;
} );
```
### wpmvc_addon_status_data
Filter `wpmvc_addon_status_data` allows to add new date to the system status report, data can be added as:
* Array
* Class instance of `StatusData`.
#### Using array
Example:
```php
add_filter( 'wpmvc_addon_status_data', function( $data ) {
$data[] = [
'section' => 'my-plugin',
'title' => __( 'API Connection', 'my-domain' );
'message' => __( 'Yes', 'my-domain' );
'status' => 1,
];
return $data;
} );
```
| Status | Description |
| --- | --- |
| `0` | Normal status. Displays with black text. |
| `1` | Success status. Displays with green text. |
| `2` | Important status. Displays with blue text. |
| `3` | Danger status. Displays with red text. |
#### Class instance
Example:
```php
namespace MyNamespace\SystemStatus;
use WPMVC\Addons\Status\Abstracts\StatusData;
/**
* Custom system status data.
*/
class ConnectionData extends StatusData
{
/**
* Checks connection.
* This method is always called by the addon to init data.
*/
public function check()
{
// Do custom code
$has_connection = true;
$this->section = 'my-plugin';
$this->title = __( 'API Connection', 'my-domain' );
$this->message = $has_connection ? 'Yes' : 'No';
$this->status = $has_connection ? 1 : 3;
}
}
```
Then add class to filter:
```php
add_filter( 'wpmvc_addon_status_data', function( $data ) {
$data[] = new ConnectionData();
return $data;
} );
```
#### Data status
| Status | Description |
| --- | --- |
| `0` | Normal status. Displays with black text. |
| `1` | Success status. Displays with green text. |
| `2` | Important status. Displays with blue text. |
| `3` | Danger status. Displays with red text. |
## Coding Guidelines
PSR-2 coding guidelines.
## License
MIT License. (c) 2020 [10 Quality](https://www.10quality.com/).