Excerpt

This document is part of the WordPress block reference and is intended for developers.

Display the excerpt.

This block is available in the latest version of WordPress and does not require the Gutenberg plugin.

Previously: “Post Excerpt”

Category: Theme

For developers

View source on GitHub

Block Grammar & Markup

<!-- wp:post-excerpt /-->

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.

[
  "postId",
  "postType",
  "queryId"
]

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

{
  "textAlign": {
    "type": "string"
  },
  "moreText": {
    "type": "string"
  },
  "showMoreOnNewLine": {
    "type": "boolean",
    "default": true
  },
  "excerptLength": {
    "type": "number",
    "default": 55
  }
}

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

{
  "html": false,
  "color": {
    "gradients": true,
    "link": true,
    "__experimentalDefaultControls": {
      "background": true,
      "text": true,
      "link": true
    }
  },
  "spacing": {
    "margin": true,
    "padding": true
  },
  "typography": {
    "fontSize": true,
    "lineHeight": true,
    "__experimentalFontFamily": true,
    "__experimentalFontWeight": true,
    "__experimentalFontStyle": true,
    "__experimentalTextTransform": true,
    "__experimentalTextDecoration": true,
    "__experimentalLetterSpacing": true,
    "__experimentalDefaultControls": {
      "fontSize": true
    }
  },
  "interactivity": {
    "clientNavigation": true
  },
  "__experimentalBorder": {
    "radius": true,
    "color": true,
    "width": true,
    "style": true,
    "__experimentalDefaultControls": {
      "radius": true,
      "color": true,
      "width": true,
      "style": true
    }
  }
}

Transforms

Optional. Type: Object.

Transforms provide rules for what a block can be transformed from and what it can be transformed to.

Documentation

Transforms from: Post content.

Transforms to: Post content.

View blocks per attribute or block support:

Block Attributes