paginate タグ（配列を複数ページに分割）

{
  "category": "iteration",
  "deprecated": false,
  "deprecation_reason": "",
  "description": "Because [`for` loops](/docs/api/liquid/tags/for) are limited to 50 iterations per page, you need to use the `paginate` tag to\niterate over an array that has more than 50 items. The following arrays can be paginated:\n\n- [`article.comments`](/docs/api/liquid/objects/article#article-comments)\n- [`blog.articles`](/docs/api/liquid/objects/blog#blog-articles)\n- [`collections`](/docs/api/liquid/objects/collections)\n- [`collection.products`](/docs/api/liquid/objects/collection#collection-products)\n- [`customer.addresses`](/docs/api/liquid/objects/customer#customer-addresses)\n- [`customer.orders`](/docs/api/liquid/objects/customer#customer-orders)\n- [`metaobject_definition.values`](/docs/api/liquid/objects/metaobject_definition#metaobject_definition-values)\n- [`pages`](/docs/api/liquid/objects/pages)\n- [`product.variants`](/docs/api/liquid/objects/product#variants)\n- [`search.results`](/docs/api/liquid/objects/search#search-results)\n- [`article_list` settings](/themes/architecture/settings/input-settings#article_list)\n- [`collection_list` settings](/themes/architecture/settings/input-settings#collection_list)\n- [`product_list` settings](/themes/architecture/settings/input-settings#product_list)\n\nWithin the `paginate` tag, you have access to the [`paginate` object](/docs/api/liquid/objects/paginate). You can use this\nobject, or the [`default_pagination` filter](/docs/api/liquid/filters/default_pagination), to build page navigation.\n\n> Note:\n> The `paginate` tag allows the user to paginate to the 25,000th item in the array and no further. To reach items further in\n> the array the array should be filtered further before paginating. See\n> [Pagination Limits](/themes/best-practices/performance/platform#pagination-limits) for more information.",
  "parameters": [
    {
      "description": "The number of pages to display in the pagination.",
      "name": "window_size",
      "positional": false,
      "required": false,
      "types": [
        "string"
      ]
    }
  ],
  "summary": "Splits an array's items across multiple pages.",
  "name": "paginate",
  "syntax": "{% paginate array by page_size %}\n  {% for item in array %}\n    forloop_content\n  {% endfor %}\n{% endpaginate %}",
  "syntax_keywords": [
    {
      "keyword": "array",
      "description": "The array to be looped over."
    },
    {
      "keyword": "page_size",
      "description": "The number of array items to include per page, between 1 and 250."
    },
    {
      "keyword": "item",
      "description": "An item in the array being looped."
    },
    {
      "keyword": "forloop_content",
      "description": "Content for each loop iteration."
    }
  ],
  "examples": [
    {
      "name": "",
      "description": "",
      "syntax": "",
      "path": "/collections/all",
      "raw_liquid": "{% paginate collection.products by 5 %}\n  {% for product in collection.products -%}\n    {{ product.title }}\n  {%- endfor %}\n\n  {{- paginate | default_pagination }}\n{% endpaginate %}",
      "parameter": false,
      "display_type": "text",
      "show_data_tab": true
    },
    {
      "name": "Paginating setting arrays",
      "description": "To allow the pagination of `article_list`, `collection_list` and `product_list` settings to operate independently from other paginated lists on a page, these lists use a pagination query parameter with a unique key. The key is automatically assigned by the `paginate` tag, and you don't need to reference the key in your code. However, you can access the key using [`paginate.page_param`](/docs/api/liquid/objects/paginate#paginate-page_param).\n\n> Tip:\n> To paginate two arrays independently without refreshing the entire page, you can use the [Section Rendering API](/docs/api/ajax/section-rendering).\n",
      "syntax": "",
      "path": "/",
      "raw_liquid": "",
      "parameter": false,
      "display_type": "text",
      "show_data_tab": true
    },
    {
      "name": "Limit data fetching",
      "description": "The [`limit` parameter](/docs/api/liquid/tags/for#for-limit) of the `for` tag controls the number of iterations, but not the amount of information fetched. Using the `paginate` tag with a matching `page_size` can reduce the data queried, leading to faster server response times. \n\nFor example, referencing `collection.products` will fetch up to 50 products by default, regardless of the forloop's `limit` parameter. Use `paginate` and set a `page_size` to limit the amount of data fetched, and opt not to display any pagination controls.\n\nMore data than requested in a specific section may be returned. Because of this, make sure to include both `paginate` and `limit` when using this technique.\n",
      "syntax": "",
      "path": "/collections/all",
      "raw_liquid": "{% paginate collection.products by 4 %}\n  {% for product in collection.products limit: 4 -%}\n    {{ product.title }}\n  {%- endfor %}\n{% endpaginate -%}\n\n<!-- Less performant method -->\n{% for product in collection.products limit: 4 -%}\n  {{ product.title }}\n{%- endfor -%}",
      "parameter": false,
      "display_type": "text",
      "show_data_tab": true
    },
    {
      "name": "window_size",
      "description": "Set the window size of the pagination. The window size is the number of pages that should be visible in the pagination navigation.\n",
      "syntax": "{% paginate collection.products by 3, window_size: 1 %}",
      "path": "/collections/all",
      "raw_liquid": "{% paginate collection.products by 3, window_size: 1 %}\n  {% for product in collection.products -%}\n    {{ product.title }}\n  {%- endfor %}\n\n  {{- paginate | default_pagination }}\n{% endpaginate %}",
      "parameter": true,
      "display_type": "text",
      "show_data_tab": true
    }
  ]
}