WordPress 插件的错误管理

过去一周,我一直在开发一个 WordPress 插件。我的一个目标是想要具有特色且内容相关的错误信息。 我打算…

过去一周,我一直在开发一个 WordPress 插件。我的一个目标是想要具有特色且内容相关的错误信息。

我打算写完我的错误管理器,甚至已经有了一个基本的版本。我不断地跨越障碍,最后我问自己,“WordPress 会不会已经有自己的错误管理器了吗?”

因此,我迅速搜索代码,并找到了 WP_Error class 。

我所遇到的一个障碍就是,错误管理器无法将错误信息本地化。而 WP_error 则轻松地解决了这个问题。

添加错误信息

要添加错误信息,你所必须要做的第一件事情就是创建自己的 WP_error 实例。

$myErrors = new WP_Error();

下一步要做的就是添加错误信息。

$myErrors->add('access_denied', __('You do not have permission to do that.',$myLocalizationName));

这里有些问题要注意。error code (错误代码)可以用来查询完整的错误信息,并且可以用 __ function 来进行错误信息的本地化。

检索错误信息

在你添加了错误信息之后,你就想要通过某个点来进行检索。

检索错误信息很简单,只需调用 get_error_message 函数,并将错误代码(即 error code)传递给他即可。

$errorMessage = $myErrors->get_error_message($code);

从那里将会输出错误信息给你。

应用

使用 WP_Error 类的办法可用于 WordPress 主题和插件。

对于插件,你的错误信息最好是作为类的一个成员(a memerb of a class)。使用类的办法可以确保获取全部错误信息,且避免命名冲突。

对于主题,你可以创建一个自己的雷,或者可以使用加了前缀的变量,尽量避免和其他变量冲突。

下载和代码实例

这里有一些可以下载的代码,以及一些关于这个类如何在主题里使用的例子。如前所述,插肩作者可能会需要使用这个类。

这个代码假设放到主题里的“functions.php”文件内。

class my_class {
	function my_class() {
		$this->localizionName = '';
		$this->errors = new WP_Error();
		$this->initialize_errors();
	}
	/* get_error - Returns an error message based on the passed code
	Parameters - $code (the error code as a string)
	Returns an error message */
	function get_error($code = '') {
		$errorMessage = $this->errors->get_error_message($code);
		if ($errorMessage == null) {
			return __("Unknown error.", $this->localizionName);
		}
		return $errorMessage;
	}
	/* Initializes all the error messages */
	function initialize_errors() {
		$this->errors->add('my_weird_error', __('Some weird error has occurred', $myLocalizationName));
		$this->errors->add('access_denied', __('You do not have permission to do that.',$myLocalizationName));
	} //end function initialize_errors
}
$myErrors = new my_class();
echo $myErrors->get_error('my_weird_error');

上面的代码有两个辅助函数,一个是用于检索错误,另一个用于初始化错误。例子都是基本,但是可以告诉你如何使用 WP_Error 类。

结论

WP_Error 类有很多功能这里没有提到,但是如果你愿意,你可以仔细研究这些代码。这个类包含在 wp-includes 文件夹内的 classes.php 文件内。

WP_Error 是个很简单,也很强大的存储错误的办法,输出错误信息也很容易。并且最棒的是,错误信息还可以本地化。

原文:Error Management for WordPress Plugins

中文:WordPress 插件的错误管理

类别:WordPress经验

本文收集自互联网,转载请注明来源。
如有侵权,请联系 wper_net@163.com 删除。

评论 (0)COMMENT