build_comment_query_vars_from_block( WP_Block $block ): array
- Since
- 6.0.0
- Source
wp-includes/blocks.php:2859
Description
It's used with the Comment Query Loop inner blocks.
Compatibility
- WordPress
- since 6.0.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
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.
Return value
array- Returns the comment query parameters to use with the WP_Comment_Query constructor.
Performance profile
How much work a call to build_comment_query_vars_from_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
- Moderate
- Scaling
- Constant
- Instructions
- 29–68
- Plugin surface
- None
- Called by
- 4
Reads stored settings via get_option(), cached per request but not free on a cold cache.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 82.
Nothing here hands control to plugin code.
4 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()one call below build_comment_query_vars_from_block() - cacheobject cache
wp_cache_get()one call below build_comment_query_vars_from_block() - serializeserialisation
maybe_unserialize()one call below build_comment_query_vars_from_block()
Further down the call graph this can also reach transient and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 10 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost build_comment_query_vars_from_block() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_user_logged_in() | 29–38 | is_user_logged_in(), wp_get_unapproved_comment_author_email(), get_option(), get_option(), get_option() |
is_user_logged_in() | 31–37 | is_user_logged_in(), get_current_user_id(), get_option(), get_option(), get_option() |
!is_user_logged_in() && !$per_page | 34–43 | is_user_logged_in(), wp_get_unapproved_comment_author_email(), get_option(), get_option(), get_option(), get_option() |
is_user_logged_in() && !$per_page | 36–42 | is_user_logged_in(), get_current_user_id(), get_option(), get_option(), get_option(), get_option() |
!is_user_logged_in() && !$per_page | 39–48 | is_user_logged_in(), wp_get_unapproved_comment_author_email(), get_option(), get_option(), get_option(), get_option(), get_option() |
is_user_logged_in() && !$per_page | 41–47 | is_user_logged_in(), get_current_user_id(), get_option(), get_option(), get_option(), get_option(), get_option() |
!is_user_logged_in() && $per_page | 43–63 | is_user_logged_in(), wp_get_unapproved_comment_author_email(), get_option(), get_option(), get_option(), get_option(), get_query_var() |
is_user_logged_in() && $per_page | 45–62 | is_user_logged_in(), get_current_user_id(), get_option(), get_option(), get_option(), get_option(), get_query_var() |
!is_user_logged_in() && $per_page | 48–68 | is_user_logged_in(), wp_get_unapproved_comment_author_email(), get_option(), get_option(), get_option(), get_option(), get_option(), get_query_var() |
is_user_logged_in() && $per_page | 50–67 | is_user_logged_in(), get_current_user_id(), get_option(), get_option(), get_option(), get_option(), get_option(), get_query_var() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 82 instructions, 29–68 executed per call, 11 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 6
- is_user_logged_in()Determines whether the current visitor is a logged in user.
- get_current_user_id()Gets the current user's ID.
- wp_get_unapproved_comment_author_email()Gets unapproved comment author's email.
- get_option()Retrieves an option value based on an option name.
- get_query_var()Retrieves the value of a query variable in the WP_Query class.
- WP_Comment_Query::__construct()Constructor.
Used by · 4
- render_block_core_comment_template()Renders the `core/comment-template` block on the server.
- render_block_core_comments_pagination_next()Renders the `core/comments-pagination-next` block on the server.
- render_block_core_comments_pagination_numbers()Renders the `core/comments-pagination-numbers` block on the server.
- render_block_core_comments_pagination_previous()Renders the `core/comments-pagination-previous` block on the server.
Source code
function build_comment_query_vars_from_block( $block ) { $comment_args = array( 'orderby' => 'comment_date_gmt', 'order' => 'ASC', 'status' => 'approve', 'no_found_rows' => false, ); if ( is_user_logged_in() ) { $comment_args['include_unapproved'] = array( get_current_user_id() ); } else { $unapproved_email = wp_get_unapproved_comment_author_email(); if ( $unapproved_email ) { $comment_args['include_unapproved'] = array( $unapproved_email ); } } if ( ! empty( $block->context['postId'] ) ) { $comment_args['post_id'] = (int) $block->context['postId']; } if ( get_option( 'thread_comments' ) ) { $comment_args['hierarchical'] = 'threaded'; } else { $comment_args['hierarchical'] = false; } if ( get_option( 'page_comments' ) === '1' || get_option( 'page_comments' ) === true ) { $per_page = get_option( 'comments_per_page' ); $default_page = get_option( 'default_comments_page' ); if ( $per_page > 0 ) { $comment_args['number'] = $per_page; $page = (int) get_query_var( 'cpage' ); if ( $page ) { $comment_args['paged'] = $page; } elseif ( 'oldest' === $default_page ) { $comment_args['paged'] = 1; } elseif ( 'newest' === $default_page ) { $max_num_pages = (int) ( new WP_Comment_Query( $comment_args ) )->max_num_pages; if ( 0 !== $max_num_pages ) { $comment_args['paged'] = $max_num_pages; } } } } return $comment_args;}Changelog
Introduced in 6.0.0. Unchanged from 6.7.7 through 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/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.