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

Description

Parameters

$blockWP_Block

Block instance.

$pageint

Current query's page.

Return

array

Returns the constructed WP_Query arguments.

Hooks 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 2942 (+245 into the body)

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

Uses · 7

• is_post_type_viewable()Determines whether a post type is considered "viewable".
• get_option()Retrieves an option value based on an option name.
• 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

View on Trac ↗View on GitHub ↗

2697function build_query_vars_from_query_block( $block, $page ) {2698	$query = array(2699		'post_type'    => 'post',2700		'order'        => 'DESC',2701		'orderby'      => 'date',2702		'post__not_in' => array(),2703		'tax_query'    => array(),2704	);2705 2706	if ( isset( $block->context['query'] ) ) {2707		if ( ! empty( $block->context['query']['postType'] ) ) {2708			$post_type_param = $block->context['query']['postType'];2709			if ( is_post_type_viewable( $post_type_param ) ) {2710				$query['post_type'] = $post_type_param;2711			}2712		}2713		if ( isset( $block->context['query']['sticky'] ) && ! empty( $block->context['query']['sticky'] ) ) {2714			$sticky = get_option( 'sticky_posts' );2715			if ( 'only' === $block->context['query']['sticky'] ) {2716				/*2717				 * Passing an empty array to post__in will return have_posts() as true (and all posts will be returned).2718				 * Logic should be used before hand to determine if WP_Query should be used in the event that the array2719				 * being passed to post__in is empty.2720				 *2721				 * @see https://core.trac.wordpress.org/ticket/280992722				 */2723				$query['post__in']            = ! empty( $sticky ) ? $sticky : array( 0 );2724				$query['ignore_sticky_posts'] = 1;2725			} elseif ( 'exclude' === $block->context['query']['sticky'] ) {2726				$query['post__not_in'] = array_merge( $query['post__not_in'], $sticky );2727			} elseif ( 'ignore' === $block->context['query']['sticky'] ) {2728				$query['ignore_sticky_posts'] = 1;2729			}2730		}2731		if ( ! empty( $block->context['query']['exclude'] ) ) {2732			$excluded_post_ids     = array_map( 'intval', $block->context['query']['exclude'] );2733			$excluded_post_ids     = array_filter( $excluded_post_ids );2734			$query['post__not_in'] = array_merge( $query['post__not_in'], $excluded_post_ids );2735		}2736		if (2737			isset( $block->context['query']['perPage'] ) &&2738			is_numeric( $block->context['query']['perPage'] )2739		) {2740			$per_page = absint( $block->context['query']['perPage'] );2741			$offset   = 0;2742 2743			if (2744				isset( $block->context['query']['offset'] ) &&2745				is_numeric( $block->context['query']['offset'] )2746			) {2747				$offset = absint( $block->context['query']['offset'] );2748			}2749 2750			$query['offset']         = ( $per_page * ( $page - 1 ) ) + $offset;2751			$query['posts_per_page'] = $per_page;2752		}2753		// Migrate `categoryIds` and `tagIds` to `tax_query` for backwards compatibility.2754		if ( ! empty( $block->context['query']['categoryIds'] ) || ! empty( $block->context['query']['tagIds'] ) ) {2755			$tax_query_back_compat = array();2756			if ( ! empty( $block->context['query']['categoryIds'] ) ) {2757				$tax_query_back_compat[] = array(2758					'taxonomy'         => 'category',2759					'terms'            => array_filter( array_map( 'intval', $block->context['query']['categoryIds'] ) ),2760					'include_children' => false,2761				);2762			}2763			if ( ! empty( $block->context['query']['tagIds'] ) ) {2764				$tax_query_back_compat[] = array(2765					'taxonomy'         => 'post_tag',2766					'terms'            => array_filter( array_map( 'intval', $block->context['query']['tagIds'] ) ),2767					'include_children' => false,2768				);2769			}2770			$query['tax_query'] = array_merge( $query['tax_query'], $tax_query_back_compat );2771		}2772 2773		if ( ! empty( $block->context['query']['taxQuery'] ) && is_array( $block->context['query']['taxQuery'] ) ) {2774			$tax_query_input = $block->context['query']['taxQuery'];2775			$tax_query       = array();2776			// If there are keys other than include/exclude, it's the old

History

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.0.4 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.