Query Total

Display the total number of results in a query.

This block is available from WordPress version 6.8 and does not require the Gutenberg plugin.

Category:

For developers

Block Grammar & Markup

<!-- wp:query-total /-->

Ancestor

Optional. Type: Array.

A block with an ancestor can be placed as an inner block of the ancestor. Either as a direct child block of the ancestor, or nested.

That allows, for example, to place a ‘Comment Content’ block inside a ‘Column’ block, as long as ‘Column’ is somewhere within a ‘Comment Template’ block.

In comparison to the parent property blocks that specify their ancestor can be placed anywhere in the subtree whilst blocks with a specified parent need to be direct children.

Documentation

[
  "core/query"
]

Context

Context is used to pass values from a block to a descendant block; for example, a query and post template passing the query ID to the inner blocks.

Documentation

Uses context. Optional. Type: Object.

[
  "queryId",
  "query"
]

Block Attributes

Optional. Type: Object.

Attributes provide the structured data needs of a block. They can exist in different forms when they are serialized, but they are declared together under a common interface.

Documentation

{
  "displayType": {
    "type": "string",
    "default": "total-results"
  }
}

Block Supports

Optional. Type: Object.

A set of options that enables or disables block controls in the editor, for example gradient colors or padding.

Documentation

{
  "align": [
    "wide",
    "full"
  ],
  "html": false,
  "spacing": {
    "margin": true,
    "padding": true
  },
  "color": {
    "gradients": true,
    "text": true,
    "__experimentalDefaultControls": {
      "background": true
    }
  },
  "typography": {
    "fontSize": true,
    "lineHeight": true,
    "__experimentalFontFamily": true,
    "__experimentalFontWeight": true,
    "__experimentalFontStyle": true,
    "__experimentalTextTransform": true,
    "__experimentalTextDecoration": true,
    "__experimentalLetterSpacing": true,
    "__experimentalDefaultControls": {
      "fontSize": true
    }
  },
  "__experimentalBorder": {
    "radius": true,
    "color": true,
    "width": true,
    "style": true,
    "__experimentalDefaultControls": {
      "radius": true,
      "color": true,
      "width": true,
      "style": true
    }
  }
}

View blocks per attribute or block support: