Document 'wp_link_query_args' and 'wp_link_query' filters. props DrewAPicture. fixes #18042.

SergeyBiryukov · SergeyBiryukov · commit 6f6decc3f257 · 2013-09-07T19:46:26.000Z
git-svn-id: https://develop.svn.wordpress.org/trunk@25299 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-includes/class-wp-editor.php b/src/wp-includes/class-wp-editor.php
@@ -798,6 +798,17 @@ public static function wp_link_query( $args = array() ) {
 
 		$query['offset'] = $args['pagenum'] > 1 ? $query['posts_per_page'] * ( $args['pagenum'] - 1 ) : 0;
 
+		/**
+		 * Filter the link query arguments.
+		 *
+		 * Allows modification of the link query arguments before querying.
+		 *
+		 * @see WP_Query for a full list of arguments
+		 *
+		 * @since 3.7.0
+		 *
+		 * @param array $query An array of WP_Query arguments.
+		 */
 		$query = apply_filters( 'wp_link_query_args', $query );
 
 		// Do main query.
@@ -823,6 +834,25 @@ public static function wp_link_query( $args = array() ) {
 			);
 		}
 
+		/**
+		 * Filter the link query results.
+		 *
+		 * Allows modification of the returned link query results.
+		 *
+		 * @since 3.7.0
+		 *
+		 * @param array $results {
+		 *     An associative array of query results.
+		 *
+		 *     @type array {
+		 *         @type int    'ID'        The post ID.
+		 *         @type string 'title'     The trimmed, escaped post title.
+		 *         @type string 'permalink' The post permalink.
+		 *         @type string 'info'      A 'Y/m/d'-formatted date for 'post' post type, the 'singular_name' post type label otherwise.
+		 *     }
+		 * }
+		 * @param array $query   An array of WP_Query arguments. @see 'wp_link_query_args' filter
+		 */
 		return apply_filters( 'wp_link_query', $results, $query );
 	}
 
