mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2025-10-16 12:05:38 +00:00
Docs: Add missing parameter notations and descriptions in the DocBlock for get_link().
See #32246. git-svn-id: https://develop.svn.wordpress.org/trunk@36025 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
parent
e2be10ec2c
commit
a052a682a1
@ -1972,17 +1972,20 @@ function get_attachment_innerHTML($id = 0, $fullsize = false, $max_dims = false)
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve bookmark data based on ID.
|
||||
* Retrieves bookmark data based on ID.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @deprecated 2.1.0 Use get_bookmark()
|
||||
* @see get_bookmark()
|
||||
*
|
||||
* @param int $bookmark_id ID of link
|
||||
* @param string $output OBJECT, ARRAY_N, or ARRAY_A
|
||||
* @return object|array
|
||||
* @param int $bookmark_id ID of link
|
||||
* @param string $output Optional. Type of output. Accepts OBJECT, ARRAY_N, or ARRAY_A.
|
||||
* Default OBJECT.
|
||||
* @param string $filter Optional. How to filter the link for output. Accepts 'raw', 'edit',
|
||||
* 'attribute', 'js', 'db', or 'display'. Default 'raw'.
|
||||
* @return object|array Bookmark object or array, depending on the type specified by `$output`.
|
||||
*/
|
||||
function get_link($bookmark_id, $output = OBJECT, $filter = 'raw') {
|
||||
function get_link( $bookmark_id, $output = OBJECT, $filter = 'raw' ) {
|
||||
_deprecated_function( __FUNCTION__, '2.1', 'get_bookmark()' );
|
||||
return get_bookmark($bookmark_id, $output, $filter);
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user