{"id":20140237,"url":"https://github.com/10quality/wpmvc-addon-status","last_synced_at":"2025-10-05T13:12:47.302Z","repository":{"id":56937916,"uuid":"281535451","full_name":"10quality/wpmvc-addon-status","owner":"10quality","description":"WordPress MVC add-on that adds a system status report and a log viewer option in admin dashboard.","archived":false,"fork":false,"pushed_at":"2023-02-10T23:04:02.000Z","size":23,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-15T20:19:31.746Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/10quality.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-22T00:37:21.000Z","updated_at":"2023-01-07T20:46:43.000Z","dependencies_parsed_at":"2023-02-08T01:31:03.949Z","dependency_job_id":null,"html_url":"https://github.com/10quality/wpmvc-addon-status","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/10quality%2Fwpmvc-addon-status","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/10quality%2Fwpmvc-addon-status/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/10quality%2Fwpmvc-addon-status/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/10quality%2Fwpmvc-addon-status/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/10quality","download_url":"https://codeload.github.com/10quality/wpmvc-addon-status/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241583986,"owners_count":19986078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T21:49:51.533Z","updated_at":"2025-10-05T13:12:42.268Z","avatar_url":"https://github.com/10quality.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Status Addon (for Wordpress MVC)\n\n[![Latest Stable Version](https://poser.pugx.org/10quality/wpmvc-addon-status/v/stable)](https://packagist.org/packages/10quality/wpmvc-addon-status)\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/10quality/wpmvc-addon-status/test.yml)\n[![Total Downloads](https://poser.pugx.org/10quality/wpmvc-addon-status/downloads)](https://packagist.org/packages/10quality/wpmvc-addon-status)\n[![License](https://poser.pugx.org/10quality/wpmvc-addon-status/license)](https://packagist.org/packages/10quality/wpmvc-addon-status)\n\nAdd-on for [WordPress MVC](http://www.wordpress-mvc.com/).\n\nThe add-on will add a \"System Status\" option inside WordPress admin dashboard, allowing for administrator to see the system status and log files.\n\nFeatures:\n\n* System status (WP, PHP and DB versions).\n* Easy JSON export.\n* WordPress MVC log file viewer.\n* Flush WordPress MVC cache.\n\n## Install and Configuration\n\nTo install, use the following composer command:\n```bash\ncomposer require 10quality/wpmvc-addon-status\n```\n\nTo configure the add-on, simply add it to your projects add-ons list at `[project]/app/Config/app.php`:\n```php\n    'addons' =\u003e [\n        'WPMVC\\Addons\\Status\\StatusAddon',\n    ],\n```\n\n## Hooks\n\nYou can add custom status information and sections.\n\n### wpmvc_addon_status_sections\n\nFilter `wpmvc_addon_status_sections` allows to add new sections to the system status report, example:\n```php\nadd_filter( 'wpmvc_addon_status_sections', function( $sections ) {\n    $sections['my-plugin'] = __( 'My Plugin', 'my-domain' );\n    return $sections;\n} );\n```\n\n### wpmvc_addon_status_data\n\nFilter `wpmvc_addon_status_data` allows to add new date to the system status report, data can be added as:\n* Array\n* Class instance of `StatusData`.\n\n#### Using array\n\nExample:\n```php\nadd_filter( 'wpmvc_addon_status_data', function( $data ) {\n    $data[] = [\n        'section' =\u003e 'my-plugin',\n        'title' =\u003e __( 'API Connection', 'my-domain' );\n        'message' =\u003e __( 'Yes', 'my-domain' );\n        'status' =\u003e 1,\n    ];\n    return $data;\n} );\n```\n\n| Status | Description |\n| --- | --- |\n| `0` | Normal status. Displays with black text. |\n| `1` | Success status. Displays with green text. |\n| `2` | Important status. Displays with blue text. |\n| `3` | Danger status. Displays with red text. |\n\n#### Class instance\n\nExample:\n```php\nnamespace MyNamespace\\SystemStatus;\n\nuse WPMVC\\Addons\\Status\\Abstracts\\StatusData;\n/**\n * Custom system status data.\n */\nclass ConnectionData extends StatusData\n{\n    /**\n     * Checks connection.\n     * This method is always called by the addon to init data.\n     */\n    public function check()\n    {\n        // Do custom code\n        $has_connection = true;\n\n        $this-\u003esection = 'my-plugin';\n        $this-\u003etitle = __( 'API Connection', 'my-domain' );\n        $this-\u003emessage = $has_connection ? 'Yes' : 'No';\n        $this-\u003estatus = $has_connection ? 1 : 3;\n    }\n}\n```\n\nThen add class to filter:\n```php\nadd_filter( 'wpmvc_addon_status_data', function( $data ) {\n    $data[] = new ConnectionData();\n    return $data;\n} );\n```\n\n#### Data status\n\n| Status | Description |\n| --- | --- |\n| `0` | Normal status. Displays with black text. |\n| `1` | Success status. Displays with green text. |\n| `2` | Important status. Displays with blue text. |\n| `3` | Danger status. Displays with red text. |\n\n\n## Coding Guidelines\n\nPSR-2 coding guidelines.\n\n## License\n\nMIT License. (c) 2020 [10 Quality](https://www.10quality.com/).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F10quality%2Fwpmvc-addon-status","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F10quality%2Fwpmvc-addon-status","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F10quality%2Fwpmvc-addon-status/lists"}