jeffreyvanrossum / wp-log
支持通过接口进行简单日志记录的包。
0.2.3
2024-07-11 11:26 UTC
Requires
- php: ^8.0|^8.1|^8.2
Requires (Dev)
- laravel/pint: ^1.4
- spatie/ray: ^1.36
README
WP Log
一个简单的包,可以将条目写入日志文件。
安装
composer require jeffreyvanrossum/wp-log
使用
您可以使用以下方式设置日志:
$log = new \Jeffreyvr\WPLog\Log('Your log');
您可以定义自定义文件路径,如果不定义,默认为 wp-content/uploads/
文件夹,文件名为日志名称的清理版本。
$log->setFilePath(wp_upload_dir()['basedir'] . '/logs/your-log-filename.log');
写入日志可以这样做:
$log->write('Your log message'); $log->write(['foo' => 'bar']);
您可以使用以下方式清除日志:
$log->clear();
interface
方法将渲染一个接口,您可以使用它来在管理区域中显示日志。
如果您想在管理菜单中显示日志页面,可以调用:
$log->interface()->inAdminMenu(slug: 'optional-slug', parent: 'tools.php');
要设置自定义权限,请使用:
$log->interface->setCapability('manage_options');
或者,如果您想将其添加为插件链接
$log->interface()->asPluginLink(basename: plugin_basename(__FILE__), slug: 'optional-slug');
您还可以调用 $log->interface()->render()
来在您想要的位置渲染它。
为了防止日志变得非常大,默认限制设置为1000项。您可以覆盖此限制
$log->setClearLimit(100); // If you don't want to limit your log, you can pass 0. $log->setClearLimit(0);
贡献者
许可证
MIT。有关更多信息,请参阅许可证文件。