diff --git a/src/wp-includes/deprecated.php b/src/wp-includes/deprecated.php index 54d9e0ec30..e95c7873e5 100644 --- a/src/wp-includes/deprecated.php +++ b/src/wp-includes/deprecated.php @@ -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); }