build_comment_query_vars_from_block() – Helper function that constructs a comment query vars array from the passed block properties.

You appear to be a bot. Output may be restricted

Description

Helper function that constructs a comment query vars array from the passed block properties.

It's used with the Comment Query Loop inner blocks.

Usage

$array = build_comment_query_vars_from_block( $block );

Parameters

$block
( WP_Block ) required – Block instance.

Returns

array Returns the comment query parameters to use with the WP_Comment_Query constructor.

Source

File name: wordpress/wp-includes/blocks.php
Lines:

1 to 56 of 56
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;
        }
      }
      // Set the `cpage` query var to ensure the previous and next pagination links are correct
      // when inheriting the Discussion Settings.
      if ( 0 === $page && isset( $comment_args['paged'] ) && $comment_args['paged'] > 0 ) {
        set_query_var( 'cpage', $comment_args['paged'] );
      }
    }
  }

  return $comment_args;
}
 

 View on GitHub View on Trac