build_query_vars_from_query_block( WP_Block $block, int $page ): array

Description

Compatibility

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

Parameters

$blockWP_Block

Block instance.

$pageint

Current query's page.

Return value

array

Returns the constructed WP_Query arguments.

Performance profile

How much work a call to build_query_vars_from_query_block() 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 get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

3

Executed per call on PHP 8.5. The body compiles to 505.

Plugin surface

1 hook

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

Called by

6

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

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()one call below build_query_vars_from_query_block()
• serializeserialisationmaybe_unserialize()one call below build_query_vars_from_query_block()
• querycontent queryget_post()one call below build_query_vars_from_query_block()

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

What one call costs · 1 distinct outcome

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

Hooks and filters fired · 1

One hook fires while build_query_vars_from_query_block() runs, in this order:

1. 1
   apply_filters( query_loop_block_query_vars )filterline 3071 (+251 into the body)

   Filters the arguments which will be passed to `WP_Query` for the Query Loop Block.

Uses · 8

• is_post_type_viewable()Determines whether a post type is considered "viewable".
• get_option()Retrieves an option value based on an option name.
• get_the_ID()Retrieves the ID of the current item in the WordPress Loop.
• absint()Converts a value to non-negative integer.
• is_taxonomy_viewable()Determines whether a taxonomy is considered "viewable".
• get_post_format_slugs()Retrieves the array of post format slugs.
• is_post_type_hierarchical()Determines whether the post type is hierarchical.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 6

• render_block_core_post_template()Renders the `core/post-template` block on the server.
• render_block_core_query_no_results()Renders the `core/query-no-results` block on the server.
• render_block_core_query_pagination_next()Renders the `core/query-pagination-next` block on the server.
• render_block_core_query_pagination_numbers()Renders the `core/query-pagination-numbers` block on the server.
• render_block_core_query_pagination_previous()Renders the `core/query-pagination-previous` block on the server.
• render_block_core_query_total()Renders the `query-total` block on the server.

Source code

View on Trac ↗View on GitHub ↗

2820function build_query_vars_from_query_block( $block, $page ) {2821	$query = array(2822		'post_type'    => 'post',2823		'order'        => 'DESC',2824		'orderby'      => 'date',2825		'post__not_in' => array(),2826		'tax_query'    => array(),2827	);2828 2829	if ( isset( $block->context['query'] ) ) {2830		if ( ! empty( $block->context['query']['postType'] ) ) {2831			$post_type_param = $block->context['query']['postType'];2832			if ( is_post_type_viewable( $post_type_param ) ) {2833				$query['post_type'] = $post_type_param;2834			}2835		}2836		if ( isset( $block->context['query']['sticky'] ) && ! empty( $block->context['query']['sticky'] ) ) {2837			$sticky = get_option( 'sticky_posts' );2838			if ( 'only' === $block->context['query']['sticky'] ) {2839				/*2840				 * Passing an empty array to post__in will return have_posts() as true (and all posts will be returned).2841				 * Logic should be used beforehand to determine if WP_Query should be used in the event that the array2842				 * being passed to post__in is empty.2843				 *2844				 * @see https://core.trac.wordpress.org/ticket/280992845				 */2846				$query['post__in']            = ! empty( $sticky ) ? $sticky : array( 0 );2847				$query['ignore_sticky_posts'] = 1;2848			} elseif ( 'exclude' === $block->context['query']['sticky'] ) {2849				$query['post__not_in'] = array_merge( $query['post__not_in'], $sticky );2850			} elseif ( 'ignore' === $block->context['query']['sticky'] ) {2851				$query['ignore_sticky_posts'] = 1;2852			}2853		}2854		if ( ! empty( $block->context['query']['exclude'] ) ) {2855			$excluded_post_ids     = array_map( 'intval', $block->context['query']['exclude'] );2856			$excluded_post_ids     = array_filter( $excluded_post_ids );2857			$query['post__not_in'] = array_merge( $query['post__not_in'], $excluded_post_ids );2858		}2859		if ( ! empty( $block->context['query']['excludeCurrent'] ) ) {2860			$current_post_id = get_the_ID();2861			if ( $current_post_id ) {2862				$query['post__not_in'][] = $current_post_id;2863			}2864		}2865		if (2866			isset( $block->context['query']['perPage'] ) &&2867			is_numeric( $block->context['query']['perPage'] )2868		) {2869			$per_page = absint( $block->context['query']['perPage'] );2870			$offset   = 0;2871 2872			if (2873				isset( $block->context['query']['offset'] ) &&2874				is_numeric( $block->context['query']['offset'] )2875			) {2876				$offset = absint( $block->context['query']['offset'] );2877			}2878 2879			$query['offset']         = ( $per_page * ( $page - 1 ) ) + $offset;2880			$query['posts_per_page'] = $per_page;2881		}2882		// Migrate `categoryIds` and `tagIds` to `tax_query` for backwards compatibility.2883		if ( ! empty( $block->context['query']['categoryIds'] ) || ! empty( $block->context['query']['tagIds'] ) ) {2884			$tax_query_back_compat = array();2885			if ( ! empty( $block->context['query']['categoryIds'] ) ) {2886				$tax_query_back_compat[] = array(2887					'taxonomy'         => 'category',2888					'terms'            => array_filter( array_map( 'intval', $block->context['query']['categoryIds'] ) ),2889					'include_children' => false,2890				);2891			}2892			if ( ! empty( $block->context['query']['tagIds'] ) ) {2893				$tax_query_back_compat[] = array(2894					'taxonomy'         => 'post_tag',2895					'terms'            => array_filter( array_map( 'intval', $block->context['query']['tagIds'] ) ),2896					'include_children' => false,2897				);2898			}2899			$query['tax_query'] = array_merge( $query['tax_query'], $tax_query_back_compat );

Changelog

Introduced in 5.8.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 7.1.0 tag, from src/wp-includes/blocks.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.