_WP_Editors::wp_link_query( array $args = array() ): array|false

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarrayoptional

Array of link query arguments.Default: array()

• $pagenumintdefault: 1

  Page number.

• $sstring

  Search keywords.

Return value

array|false

$results { An array of associative arrays of query results, false if there are none.

• ...$0array

  @type int $ID Post ID.

  • $titlestring

    The trimmed, escaped post title.

  • $permalinkstring

    Post permalink.

  • $infostring

    A 'Y/m/d'-formatted date for 'post' post type, the 'singular_name' post type label otherwise.

Performance profile

How much work a call to _WP_Editors::wp_link_query() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via ->query().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

54–67

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 112.

Plugin surface

2 hooks

Third-party callbacks on 'wp_link_query_args', 'wp_link_query' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• sqldatabase query->query()called directly
• querycontent queryget_post()one call below _WP_Editors::wp_link_query()
• optionoption read or writeget_option()one call below _WP_Editors::wp_link_query()

Further down the call graph this can also reach cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost _WP_Editors::wp_link_query() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while _WP_Editors::wp_link_query() runs, in this order:

1. 1
   apply_filters( wp_link_query_args )filterline 1813 (+32 into the body)

   Filters the link query arguments.

2. 2
   apply_filters( wp_link_query )filterline 1858 (+77 into the body)

   Filters the link query results.

Uses · 9

• get_post_types()Gets a list of all registered post type objects.
• absint()Converts a value to non-negative integer.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• mysql2date()Converts given MySQL date string into a different format.
• __()Retrieves the translation of $text.
• esc_html()Escaping for HTML blocks.
• get_the_title()Retrieves the post title.
• get_permalink()Retrieves the full permalink for the current post or post ID.
• WP_Query::__construct()Constructor.

Used by · 1

• wp_ajax_wp_link_ajax()Handles internal linking via AJAX.

Source code

View on Trac ↗View on GitHub ↗

1781	public static function wp_link_query( $args = array() ) {1782		$pts      = get_post_types( array( 'public' => true ), 'objects' );1783		$pt_names = array_keys( $pts );1784 1785		$query = array(1786			'post_type'              => $pt_names,1787			'suppress_filters'       => true,1788			'update_post_term_cache' => false,1789			'update_post_meta_cache' => false,1790			'post_status'            => 'publish',1791			'posts_per_page'         => 20,1792		);1793 1794		$args['pagenum'] = isset( $args['pagenum'] ) ? absint( $args['pagenum'] ) : 1;1795 1796		if ( isset( $args['s'] ) ) {1797			$query['s'] = $args['s'];1798		}1799 1800		$query['offset'] = $args['pagenum'] > 1 ? $query['posts_per_page'] * ( $args['pagenum'] - 1 ) : 0;1801 1802		/**1803		 * Filters the link query arguments.1804		 *1805		 * Allows modification of the link query arguments before querying.1806		 *1807		 * @see WP_Query for a full list of arguments1808		 *1809		 * @since 3.7.01810		 *1811		 * @param array $query An array of WP_Query arguments.1812		 */1813		$query = apply_filters( 'wp_link_query_args', $query );1814 1815		// Do main query.1816		$get_posts = new WP_Query();1817		$posts     = $get_posts->query( $query );1818 1819		// Build results.1820		$results = array();1821		foreach ( $posts as $post ) {1822			if ( 'post' === $post->post_type ) {1823				$info = mysql2date( __( 'Y/m/d' ), $post->post_date );1824			} else {1825				$info = $pts[ $post->post_type ]->labels->singular_name;1826			}1827 1828			$results[] = array(1829				'ID'        => $post->ID,1830				'title'     => trim( esc_html( strip_tags( get_the_title( $post ) ) ) ),1831				'permalink' => get_permalink( $post->ID ),1832				'info'      => $info,1833			);1834		}1835 1836		/**1837		 * Filters the link query results.1838		 *1839		 * Allows modification of the returned link query results.1840		 *1841		 * @since 3.7.01842		 *1843		 * @see 'wp_link_query_args' filter1844		 *1845		 * @param array $results {1846		 *     An array of associative arrays of query results.1847		 *1848		 *     @type array ...$0 {1849		 *         @type int    $ID        Post ID.1850		 *         @type string $title     The trimmed, escaped post title.1851		 *         @type string $permalink Post permalink.1852		 *         @type string $info      A 'Y/m/d'-formatted date for 'post' post type,1853		 *                                 the 'singular_name' post type label otherwise.1854		 *     }1855		 * }1856		 * @param array $query  An array of WP_Query arguments.1857		 */1858		$results = apply_filters( 'wp_link_query', $results, $query );1859 1860		return ! empty( $results ) ? $results : false;

Changelog

Introduced in 3.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/class-wp-editor.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.