inpsyde / wonolog
基于Monolog的WordPress日志包。
Requires
- php: >=8.1 < 8.3
- monolog/monolog: ^2.3.5
- psr/log: ^2.0||^3.0
- wecodemore/wordpress-early-hook: ^1.1.0
Requires (Dev)
- brain/monkey: ^2.6.1
- fig/log-test: ^1.1
- globalis/wp-cli-bin: ^2.7.1
- inpsyde/php-coding-standards: ^1
- inpsyde/wp-stubs-versions: dev-latest
- mikey179/vfsstream: ~v1.6.11
- mockery/mockery: ^1.3.6
- phpunit/phpunit: ^9.6
- roots/wordpress-no-content: >=6.1.1
- symfony/process: ^v4.4.44
- vimeo/psalm: ^5.15
Provides
- psr/log-implementation: 1.0.0
This package is auto-updated.
Last update: 2024-09-19 11:17:53 UTC
README
基于Monolog的WordPress日志包。
目录
介绍
Wonolog是一个Composer包(不是插件),允许记录WordPress站点上发生的任何内容。
它基于Monolog,拥有超过3800万次下载和数千个依赖包,是PHP中最受欢迎的日志库,兼容PSR-3标准。
最低要求和依赖项
Wonolog需要
- PHP 5.6+
- WordPress 4.6+
通过Composer,Wonolog需要monolog/monolog
(MIT)。
在开发模式下安装,通过Composer,Wonolog还需要
phpunit/phpunit
(BSD-3-Clause)brain/monkey
(MIT)mikey179/vfsStream
(BSD-3-Clause)
入门指南
应通过Composer安装Wonolog。其包名为inpsyde/wonolog
。
建议在网站级别使用Wonolog。
如果您不使用Composer来管理整个网站,那么Wonolog可能不适合您。尽管如此,您可能仍然能够使用它,但无法保证支持。
即使在没有显式声明为依赖项的情况下,也可以轻松开发与Wonolog日志兼容的插件和主题。
以下几点值得注意
- 所有Wonolog配置都必须在MU插件中完成;
- 在WordPress多站点安装中,所有Wonolog配置都是自然的全站。
另一方面,Wonolog提供了一个超级简单的引导程序和一些开箱即用的配置,使得零成本即可拥有一个有效的工作日志系统。
要使用默认设置开始,需要以下步骤
- 通过Composer安装Wonolog;
- 确保在
wp-config.php
中加载Composer的自动加载,或者在触发'muplugins_loaded'
动作之前; - 创建一个至少包含以下代码的MU插件
<?php Inpsyde\Wonolog\bootstrap();
Wonolog默认设置
上述描述的三个步骤就是拥有一个使用Monolog将日志写入文件的日志系统的所有必要步骤。该文件的路径基于当前日期,使用以下格式
{WP_CONTENT_DIR}/wonolog/{Y/m/d}.log
,
其中{Y/m/d}
由date( 'Y/m/d' )
替换。
例如,目标文件可能是/wp-content/2017/02/27.log
。
实际记录的内容取决于WP_DEBUG_LOG
常量的值。
当WP_DEBUG_LOG
设置为true
时,Wonolog将记录一切。当WP_DEBUG_LOG
设置为false
时,Wonolog将仅记录日志级别高于或等于ERROR
的事件,根据PSR-3日志级别。
“自动”记录的事件包括
- PHP核心通知、警告和(致命)错误;
- 未捕获的异常;
- WordPress错误和事件(例如,数据库错误、HTTP API错误、
wp_mail()
错误和404错误)。
这只是默认行为。
该bootstrap()
函数提供了许多配置和自定义的入口点。
此外,该包提供动作和过滤器钩子,可以通过环境变量进行配置,这使得Wonolog非常灵活,并暴露了Monolog提供的所有功能。
了解更多
关于Wonolog的功能、默认设置、配置方法和扩展方式的文档可以分别在其他文件中找到。
- 01 - Monolog 简介,以了解更多关于Monolog核心概念的信息。
- 02 - 基础 Wonolog 概念,学习使用Wonolog进行日志记录的基础知识。
- 03 - 深入了解 Wonolog,学习Wonolog的更多高级概念和功能。
- 04 - 钩子监听器,了解钩子监听器,这是Wonolog的强大功能,允许记录任何WordPress代码。
- 05 - Wonolog 自定义,深入了解该包所有方面的可能配置。
- 06 - 自定义钩子监听器,查看自定义钩子监听器的完整示例,其在Wonolog中的集成以及编写可重用Wonolog扩展所需了解的所有内容。
许可和版权
该存储库是免费软件,并按照MIT许可协议发布。请参阅LICENSE获取完整的许可协议。