函数文档

get_real_file_to_edit()

💡 云策文档标注

概述

get_real_file_to_edit() 是一个已弃用的 WordPress 函数,用于获取相对于 wp-content 目录的文件系统路径的完整路径,以便在管理后台编辑文件。

关键要点

  • 函数已弃用:自 WordPress 2.9.0 版本起被标记为弃用,建议开发者避免使用。
  • 参数要求:接受一个字符串参数 $file,表示相对于 wp-content 目录的文件系统路径。
  • 返回值:返回完整的文件系统路径,通过拼接 WP_CONTENT_DIR 和 $file 实现。
  • 相关函数:与 _deprecated_function() 相关,用于标记弃用函数并通知使用情况。

代码示例

function get_real_file_to_edit( $file ) {
    _deprecated_function( __FUNCTION__, '2.9.0' );
    return WP_CONTENT_DIR . $file;
}

注意事项

  • 弃用状态:此函数已弃用,开发者应寻找替代方案或更新代码以避免兼容性问题。
  • 版本历史:在 WordPress 1.5.0 中引入,2.9.0 中弃用。

📄 原文内容

Get the real filesystem path to a file to edit within the admin.

Parameters

$filestringrequired
Filesystem path relative to the wp-content directory.

Return

string Full filesystem path to edit.

Source

function get_real_file_to_edit( $file ) {
	_deprecated_function( __FUNCTION__, '2.9.0' );

	return WP_CONTENT_DIR . $file;
}

Changelog

Version Description
2.9.0 Deprecated.
1.5.0 Introduced.