[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Server-side rendering of the `core/query` block.
   4   *
   5   * @package WordPress
   6   */
   7  
   8  /**
   9   * Modifies the static `core/query` block on the server.
  10   *
  11   * @since 6.4.0
  12   *
  13   * @param array    $attributes Block attributes.
  14   * @param string   $content    Block default content.
  15   * @param WP_Block $block      The block instance.
  16   *
  17   * @return string Returns the modified output of the query block.
  18   */
  19  function render_block_core_query( $attributes, $content, $block ) {
  20      $is_interactive = isset( $attributes['enhancedPagination'] )
  21          && true === $attributes['enhancedPagination']
  22          && isset( $attributes['queryId'] );
  23  
  24      // Enqueue the script module and add the necessary directives if the block is
  25      // interactive.
  26      if ( $is_interactive ) {
  27          $suffix = wp_scripts_get_suffix();
  28          if ( defined( 'IS_GUTENBERG_PLUGIN' ) && IS_GUTENBERG_PLUGIN ) {
  29              $module_url = gutenberg_url( '/build/interactivity/query.min.js' );
  30          }
  31  
  32          wp_register_script_module(
  33              '@wordpress/block-library/query',
  34              isset( $module_url ) ? $module_url : includes_url( "blocks/query/view{$suffix}.js" ),
  35              array(
  36                  array(
  37                      'id'     => '@wordpress/interactivity',
  38                      'import' => 'static',
  39                  ),
  40                  array(
  41                      'id'     => '@wordpress/interactivity-router',
  42                      'import' => 'dynamic',
  43                  ),
  44              ),
  45              defined( 'GUTENBERG_VERSION' ) ? GUTENBERG_VERSION : get_bloginfo( 'version' )
  46          );
  47          wp_enqueue_script_module( '@wordpress/block-library/query' );
  48  
  49          $p = new WP_HTML_Tag_Processor( $content );
  50          if ( $p->next_tag() ) {
  51              // Add the necessary directives.
  52              $p->set_attribute( 'data-wp-interactive', 'core/query' );
  53              $p->set_attribute( 'data-wp-router-region', 'query-' . $attributes['queryId'] );
  54              $p->set_attribute( 'data-wp-init', 'callbacks.setQueryRef' );
  55              $p->set_attribute( 'data-wp-context', '{}' );
  56              $content = $p->get_updated_html();
  57          }
  58      }
  59  
  60      // Add the styles to the block type if the block is interactive and remove
  61      // them if it's not.
  62      $style_asset = 'wp-block-query';
  63      if ( ! wp_style_is( $style_asset ) ) {
  64          $style_handles = $block->block_type->style_handles;
  65          // If the styles are not needed, and they are still in the `style_handles`, remove them.
  66          if ( ! $is_interactive && in_array( $style_asset, $style_handles, true ) ) {
  67              $block->block_type->style_handles = array_diff( $style_handles, array( $style_asset ) );
  68          }
  69          // If the styles are needed, but they were previously removed, add them again.
  70          if ( $is_interactive && ! in_array( $style_asset, $style_handles, true ) ) {
  71              $block->block_type->style_handles = array_merge( $style_handles, array( $style_asset ) );
  72          }
  73      }
  74  
  75      return $content;
  76  }
  77  
  78  /**
  79   * Registers the `core/query` block on the server.
  80   */
  81  function register_block_core_query() {
  82      register_block_type_from_metadata(
  83          __DIR__ . '/query',
  84          array(
  85              'render_callback' => 'render_block_core_query',
  86          )
  87      );
  88  }
  89  add_action( 'init', 'register_block_core_query' );
  90  
  91  /**
  92   * Traverse the tree of blocks looking for any plugin block (i.e., a block from
  93   * an installed plugin) inside a Query block with the enhanced pagination
  94   * enabled. If at least one is found, the enhanced pagination is effectively
  95   * disabled to prevent any potential incompatibilities.
  96   *
  97   * @since 6.4.0
  98   *
  99   * @param array $parsed_block The block being rendered.
 100   * @return string Returns the parsed block, unmodified.
 101   */
 102  function block_core_query_disable_enhanced_pagination( $parsed_block ) {
 103      static $enhanced_query_stack   = array();
 104      static $dirty_enhanced_queries = array();
 105      static $render_query_callback  = null;
 106  
 107      $block_name              = $parsed_block['blockName'];
 108      $block_type              = WP_Block_Type_Registry::get_instance()->get_registered( $block_name );
 109      $has_enhanced_pagination = isset( $parsed_block['attrs']['enhancedPagination'] ) && true === $parsed_block['attrs']['enhancedPagination'] && isset( $parsed_block['attrs']['queryId'] );
 110      /*
 111       * Client side navigation can be true in two states:
 112       *  - supports.interactivity = true;
 113       *  - supports.interactivity.clientNavigation = true;
 114       */
 115      $supports_client_navigation = ( isset( $block_type->supports['interactivity']['clientNavigation'] ) && true === $block_type->supports['interactivity']['clientNavigation'] )
 116          || ( isset( $block_type->supports['interactivity'] ) && true === $block_type->supports['interactivity'] );
 117  
 118      if ( 'core/query' === $block_name && $has_enhanced_pagination ) {
 119          $enhanced_query_stack[] = $parsed_block['attrs']['queryId'];
 120  
 121          if ( ! isset( $render_query_callback ) ) {
 122              /**
 123               * Filter that disables the enhanced pagination feature during block
 124               * rendering when a plugin block has been found inside. It does so
 125               * by adding an attribute called `data-wp-navigation-disabled` which
 126               * is later handled by the front-end logic.
 127               *
 128               * @param string   $content  The block content.
 129               * @param array    $block    The full block, including name and attributes.
 130               * @return string Returns the modified output of the query block.
 131               */
 132              $render_query_callback = static function ( $content, $block ) use ( &$enhanced_query_stack, &$dirty_enhanced_queries, &$render_query_callback ) {
 133                  $has_enhanced_pagination = isset( $block['attrs']['enhancedPagination'] ) && true === $block['attrs']['enhancedPagination'] && isset( $block['attrs']['queryId'] );
 134  
 135                  if ( ! $has_enhanced_pagination ) {
 136                      return $content;
 137                  }
 138  
 139                  if ( isset( $dirty_enhanced_queries[ $block['attrs']['queryId'] ] ) ) {
 140                      // Disable navigation in the router store config.
 141                      wp_interactivity_config( 'core/router', array( 'clientNavigationDisabled' => true ) );
 142                      $dirty_enhanced_queries[ $block['attrs']['queryId'] ] = null;
 143                  }
 144  
 145                  array_pop( $enhanced_query_stack );
 146  
 147                  if ( empty( $enhanced_query_stack ) ) {
 148                      remove_filter( 'render_block_core/query', $render_query_callback );
 149                      $render_query_callback = null;
 150                  }
 151  
 152                  return $content;
 153              };
 154  
 155              add_filter( 'render_block_core/query', $render_query_callback, 10, 2 );
 156          }
 157      } elseif (
 158          ! empty( $enhanced_query_stack ) &&
 159          isset( $block_name ) &&
 160          ( ! $supports_client_navigation )
 161      ) {
 162          foreach ( $enhanced_query_stack as $query_id ) {
 163              $dirty_enhanced_queries[ $query_id ] = true;
 164          }
 165      }
 166  
 167      return $parsed_block;
 168  }
 169  
 170  add_filter( 'render_block_data', 'block_core_query_disable_enhanced_pagination', 10, 1 );