Custom Link

Add a page, link, or another item to your navigation.

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

Last updated

April 20, 2024

Category: Design

For developers

View source on GitHub

Block Grammar & Markup

<!-- wp:navigation-link {"label":"WordPress","url":"https://wordpress.org/"} -->
<!-- /wp:navigation-link -->

Parent

Optional. Type: Array.

Blocks are able to be inserted into blocks that use InnerBlocks as nested content. Setting parent lets a block require that it is only available when nested within the specified blocks.

Documentation

[
  "core/navigation"
]

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.

[
  "textColor",
  "customTextColor",
  "backgroundColor",
  "customBackgroundColor",
  "overlayTextColor",
  "customOverlayTextColor",
  "overlayBackgroundColor",
  "customOverlayBackgroundColor",
  "fontSize",
  "customFontSize",
  "showSubmenuIcon",
  "maxNestingLevel",
  "style"
]

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

{
  "label": {
    "type": "string"
  },
  "type": {
    "type": "string"
  },
  "description": {
    "type": "string"
  },
  "rel": {
    "type": "string"
  },
  "id": {
    "type": "number"
  },
  "opensInNewTab": {
    "type": "boolean",
    "default": false
  },
  "url": {
    "type": "string"
  },
  "title": {
    "type": "string"
  },
  "kind": {
    "type": "string"
  },
  "isTopLevelLink": {
    "type": "boolean"
  }
}

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

{
  "reusable": false,
  "html": false,
  "__experimentalSlashInserter": true,
  "typography": {
    "fontSize": true,
    "lineHeight": true,
    "__experimentalFontFamily": true,
    "__experimentalFontWeight": true,
    "__experimentalFontStyle": true,
    "__experimentalTextTransform": true,
    "__experimentalTextDecoration": true,
    "__experimentalLetterSpacing": true,
    "__experimentalDefaultControls": {
      "fontSize": true
    }
  },
  "renaming": false,
  "interactivity": {
    "clientNavigation": 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: Site logo. Spacer. Home link. Social links. Search. Page list. Buttons.

Transforms to: Navigation submenu. Spacer. Site logo. Home link. Social links. Search. Page list. Buttons.

View blocks per attribute or block support:

Block Attributes