summaryrefslogtreecommitdiffstats
path: root/wp-includes/blocks/query-pagination-numbers.php
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:56:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:56:49 +0000
commita415c29efee45520ae252d2aa28f1083a521cd7b (patch)
treef4ade4b6668ecc0765de7e1424f7c1427ad433ff /wp-includes/blocks/query-pagination-numbers.php
parentInitial commit. (diff)
downloadwordpress-a415c29efee45520ae252d2aa28f1083a521cd7b.tar.xz
wordpress-a415c29efee45520ae252d2aa28f1083a521cd7b.zip
Adding upstream version 6.4.3+dfsg1.upstream/6.4.3+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'wp-includes/blocks/query-pagination-numbers.php')
-rw-r--r--wp-includes/blocks/query-pagination-numbers.php124
1 files changed, 124 insertions, 0 deletions
diff --git a/wp-includes/blocks/query-pagination-numbers.php b/wp-includes/blocks/query-pagination-numbers.php
new file mode 100644
index 0000000..9809853
--- /dev/null
+++ b/wp-includes/blocks/query-pagination-numbers.php
@@ -0,0 +1,124 @@
+<?php
+/**
+ * Server-side rendering of the `core/query-pagination-numbers` block.
+ *
+ * @package WordPress
+ */
+
+/**
+ * Renders the `core/query-pagination-numbers` block on the server.
+ *
+ * @param array $attributes Block attributes.
+ * @param string $content Block default content.
+ * @param WP_Block $block Block instance.
+ *
+ * @return string Returns the pagination numbers for the Query.
+ */
+function render_block_core_query_pagination_numbers( $attributes, $content, $block ) {
+ $page_key = isset( $block->context['queryId'] ) ? 'query-' . $block->context['queryId'] . '-page' : 'query-page';
+ $enhanced_pagination = isset( $block->context['enhancedPagination'] ) && $block->context['enhancedPagination'];
+ $page = empty( $_GET[ $page_key ] ) ? 1 : (int) $_GET[ $page_key ];
+ $max_page = isset( $block->context['query']['pages'] ) ? (int) $block->context['query']['pages'] : 0;
+
+ $wrapper_attributes = get_block_wrapper_attributes();
+ $content = '';
+ global $wp_query;
+ $mid_size = isset( $block->attributes['midSize'] ) ? (int) $block->attributes['midSize'] : null;
+ if ( isset( $block->context['query']['inherit'] ) && $block->context['query']['inherit'] ) {
+ // Take into account if we have set a bigger `max page`
+ // than what the query has.
+ $total = ! $max_page || $max_page > $wp_query->max_num_pages ? $wp_query->max_num_pages : $max_page;
+ $paginate_args = array(
+ 'prev_next' => false,
+ 'total' => $total,
+ );
+ if ( null !== $mid_size ) {
+ $paginate_args['mid_size'] = $mid_size;
+ }
+ $content = paginate_links( $paginate_args );
+ } else {
+ $block_query = new WP_Query( build_query_vars_from_query_block( $block, $page ) );
+ // `paginate_links` works with the global $wp_query, so we have to
+ // temporarily switch it with our custom query.
+ $prev_wp_query = $wp_query;
+ $wp_query = $block_query;
+ $total = ! $max_page || $max_page > $wp_query->max_num_pages ? $wp_query->max_num_pages : $max_page;
+ $paginate_args = array(
+ 'base' => '%_%',
+ 'format' => "?$page_key=%#%",
+ 'current' => max( 1, $page ),
+ 'total' => $total,
+ 'prev_next' => false,
+ );
+ if ( null !== $mid_size ) {
+ $paginate_args['mid_size'] = $mid_size;
+ }
+ if ( 1 !== $page ) {
+ /**
+ * `paginate_links` doesn't use the provided `format` when the page is `1`.
+ * This is great for the main query as it removes the extra query params
+ * making the URL shorter, but in the case of multiple custom queries is
+ * problematic. It results in returning an empty link which ends up with
+ * a link to the current page.
+ *
+ * A way to address this is to add a `fake` query arg with no value that
+ * is the same for all custom queries. This way the link is not empty and
+ * preserves all the other existent query args.
+ *
+ * @see https://developer.wordpress.org/reference/functions/paginate_links/
+ *
+ * The proper fix of this should be in core. Track Ticket:
+ * @see https://core.trac.wordpress.org/ticket/53868
+ *
+ * TODO: After two WP versions (starting from the WP version the core patch landed),
+ * we should remove this and call `paginate_links` with the proper new arg.
+ */
+ $paginate_args['add_args'] = array( 'cst' => '' );
+ }
+ // We still need to preserve `paged` query param if exists, as is used
+ // for Queries that inherit from global context.
+ $paged = empty( $_GET['paged'] ) ? null : (int) $_GET['paged'];
+ if ( $paged ) {
+ $paginate_args['add_args'] = array( 'paged' => $paged );
+ }
+ $content = paginate_links( $paginate_args );
+ wp_reset_postdata(); // Restore original Post Data.
+ $wp_query = $prev_wp_query;
+ }
+
+ if ( empty( $content ) ) {
+ return '';
+ }
+
+ if ( $enhanced_pagination ) {
+ $p = new WP_HTML_Tag_Processor( $content );
+ while ( $p->next_tag(
+ array(
+ 'tag_name' => 'a',
+ 'class_name' => 'page-numbers',
+ )
+ ) ) {
+ $p->set_attribute( 'data-wp-on--click', 'actions.core.query.navigate' );
+ }
+ $content = $p->get_updated_html();
+ }
+
+ return sprintf(
+ '<div %1$s>%2$s</div>',
+ $wrapper_attributes,
+ $content
+ );
+}
+
+/**
+ * Registers the `core/query-pagination-numbers` block on the server.
+ */
+function register_block_core_query_pagination_numbers() {
+ register_block_type_from_metadata(
+ __DIR__ . '/query-pagination-numbers',
+ array(
+ 'render_callback' => 'render_block_core_query_pagination_numbers',
+ )
+ );
+}
+add_action( 'init', 'register_block_core_query_pagination_numbers' );