Changeset 36025

Timestamp:

12/19/2015 08:53:55 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Add missing parameter notations and descriptions in the DocBlock for get_link().

See #32246.

File:

• trunk/src/wp-includes/deprecated.php (modified) (2 diffs)

trunk/src/wp-includes/deprecated.php

@@ -1973 +1973 @@
 
 /**
- * Retrieve bookmark data based on ID.
+ * Retrieves bookmark data based on ID.
  *
  * @since 2.0.0
@@ -1979 +1979 @@
  * @see get_bookmark()
  *
- * @param int $bookmark_id ID of link
- * @param string $output OBJECT, ARRAY_N, or ARRAY_A
- * @return object|array
- */
-function get_link($bookmark_id, $output = OBJECT, $filter = 'raw') {
+ * @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' ) {
     _deprecated_function( __FUNCTION__, '2.1', 'get_bookmark()' );
     return get_bookmark($bookmark_id, $output, $filter);