函数文档

get_link_to_edit()

💡 云策文档标注

概述

get_link_to_edit() 函数用于基于链接 ID 或对象检索链接数据,主要用于编辑操作。它通过调用 get_bookmark() 函数并指定 'edit' 上下文来实现。

关键要点

  • 参数 $link 可以是整数 ID 或 stdClass 对象,用于指定要检索的链接。
  • 返回一个链接对象,适用于编辑场景。
  • 内部实现依赖于 get_bookmark() 函数,传递 OBJECT 类型和 'edit' 上下文。
  • 自 WordPress 2.0.0 版本引入,无后续变更记录。

代码示例

function get_link_to_edit( $link ) {
    return get_bookmark( $link, OBJECT, 'edit' );
}

注意事项

此函数是 get_bookmark() 的包装器,专为编辑操作设计,确保在检索链接数据时应用适当的权限和上下文处理。


📄 原文内容

Retrieves link data based on its ID.

Parameters

$linkint|stdClassrequired
Link ID or object to retrieve.

Return

object Link object for editing.

Source

function get_link_to_edit( $link ) {
	return get_bookmark( $link, OBJECT, 'edit' );
}

Changelog

Version Description
2.0.0 Introduced.