10quality/wpmvc-addon-status

WordPress MVC框架的系统状态报告页面。

v1.0.3 2023-02-10 23:02 UTC

This package is auto-updated.

Last update: 2024-09-11 02:16:22 UTC


README

Latest Stable Version GitHub Workflow Status Total Downloads License

WordPress MVC插件

此插件将在WordPress管理仪表板中添加“系统状态”选项,允许管理员查看系统状态和日志文件。

功能

  • 系统状态(WP、PHP和数据库版本)。
  • 简单的JSON导出。
  • WordPress MVC日志文件查看器。
  • 刷新WordPress MVC缓存。

安装和配置

要安装,请使用以下composer命令

composer require 10quality/wpmvc-addon-status

要配置此插件,只需将其添加到项目的插件列表中,位置为[项目]/app/Config/app.php

    'addons' => [
        'WPMVC\Addons\Status\StatusAddon',
    ],

钩子

您可以添加自定义状态信息和部分。

wpmvc_addon_status_sections

过滤器 wpmvc_addon_status_sections 允许向系统状态报告添加新部分,示例

add_filter( 'wpmvc_addon_status_sections', function( $sections ) {
    $sections['my-plugin'] = __( 'My Plugin', 'my-domain' );
    return $sections;
} );

wpmvc_addon_status_data

过滤器 wpmvc_addon_status_data 允许向系统状态报告添加新数据,数据可以添加为

  • 数组
  • StatusData类的实例。

使用数组

示例

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;
} );

类实例

示例

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;
    }
}

然后添加类到过滤器

add_filter( 'wpmvc_addon_status_data', function( $data ) {
    $data[] = new ConnectionData();
    return $data;
} );

数据状态

编码规范

PSR-2编码规范。

许可

MIT许可。版权所有 (c) 2020 10 Quality