WPGO documentationSimple Sitemap

Generated product reference

Every Simple Sitemap control, in one place.

Use this technical reference when you know the block, shortcode, or setting you need. It is generated from the same public contracts used by Simple Sitemap 3.6.2.

Current documentation Version 3.6.2Released 11 August 2026See what changed
Blocks7

Editor controls and saved block attributes.

Shortcodes5

Established shortcode attributes and aliases.

Plugin settings3

Retained settings for existing installations.

Block editor

Block settings

The saved attribute name is shown below each human label. Pro rows appear only when the Pro edition provides that control.

Block · 40 settings

Content Sitemap

Free

List one or more public content types, with optional tabs, labels, excerpts, filtering, pagination, and Pro presentation controls.

Content Sitemap settings
SettingEditionType and defaultPurpose and accepted values
Unique sitemap IDidFreestringDefault: Empty

Use a stable identifier when more than one similar sitemap appears on a Page.

  • Letters, numbers, hyphens, and underscores
  • Empty for an automatic ID
Page depthpage_depthFreenumberDefault: 0

Limit hierarchical Page output to a specific number of descendant levels.

  • 0 for every level
  • A positive whole number
Order byorderbyFreestringDefault: title

Choose the field used to sort returned items.

  • title
  • date
  • menu_order
  • name
  • ID
  • author
  • comment_count
  • rand where supported
Sort directionorderFreestringDefault: asc

Choose ascending or descending result order.

  • ASC
  • DESC
Show excerptsshow_excerptFreebooleanDefault: false

Display an excerpt beneath each supported item.

  • On
  • Off
Show section labelsshow_labelFreebooleanDefault: true

Display a heading for each selected content type or section.

  • On
  • Off
Link itemslinksFreebooleanDefault: true

Render sitemap item titles as links to their public URLs.

  • On
  • Off
Open links in a new tabtarget_blankFreebooleanDefault: false

Open generated sitemap links in a new browser tab.

  • On
  • Off
Include IDsincludeFreestringDefault: Empty

Include only the exact content or term IDs supplied.

  • Comma-separated positive IDs
  • Empty for no include restriction
Exclude IDsexcludeFreestringDefault: Empty

Exclude the exact content or term IDs supplied.

  • Comma-separated positive IDs
  • Empty for no exclusions
Enable paginationpaginateFreebooleanDefault: false

Split a large result into bounded linked pages.

  • On
  • Off
Entries per pagepage_sizeFreenumberDefault: 50

Maximum number of items displayed on each generated result page.

  • 1 to 500
Title elementtitle_tagFreestringDefault: Empty

Optional HTML element used for the overall sitemap title.

  • h2 to h6
  • div
  • p
  • Empty for no generated title
Section heading elementpost_type_tagFreestringDefault: h3

HTML element used for content-type section headings.

  • h2 to h6
  • div
  • p
Excerpt elementexcerpt_tagFreestringDefault: div

HTML element wrapped around generated excerpts.

  • div
  • p
  • span
List elementcontainer_tagFreestringDefault: ul

Choose an unordered or ordered list container.

  • ul
  • ol
Display as tabsrender_tabFreebooleanDefault: false

Display each selected content type in a tabbed interface.

  • On
  • Off
Content typesblock_post_typesFreestringDefault: [{ "value": "page", "label": "Pages" }]

Select the public content types included by the block.

  • One or more public content types
Exclude descendantsexclude_childProbooleanDefault: false

When an excluded Page is hierarchical, omit its descendants as well.

  • On
  • Off
Show featured imagesimageProbooleanDefault: false

Display the featured image beside supported sitemap items.

  • On
  • Off
Image sizeimage_sizePronumberDefault: 22

Rendered square image size in pixels.

  • A positive pixel value
Show list iconslist_iconProbooleanDefault: true

Retain the standard list marker or icon treatment.

  • On
  • Off
Show separatorsseparatorProbooleanDefault: false

Insert a visual separator between supported sitemap items.

  • On
  • Off
Horizontal layouthorizontalProbooleanDefault: false

Display content items in a compact horizontal flow.

  • On
  • Off
Horizontal separatorhorizontal_separatorProstringDefault: ,

Text inserted between horizontally displayed items.

  • Plain text or punctuation
  • Empty for no separator
Add nofollownofollowProbooleanDefault: false

Add rel=nofollow to generated links.

  • On
  • Off
Maximum itemsnum_postsPronumberDefault: -1

Limit the number of content items returned for each section.

  • -1 for no explicit limit
  • 0 or a positive whole number
Include private contentvisibilityProbooleanDefault: false

Allow content visible to the current authorised visitor to appear; private content remains permission controlled.

  • On
  • Off
Excerpt lengthpage_excerpt_lengthPronumberDefault: 25

Maximum number of words shown in shortcode or Content Sitemap excerpts.

  • A positive whole number
Item line heightsitemap_item_line_heightProstringDefault: Empty

Optional CSS line-height applied to sitemap items.

  • A valid CSS line-height
  • Empty to inherit the theme
Container marginsitemap_container_marginProstringDefault: Empty

Optional CSS margin applied to the sitemap container.

  • A valid CSS margin
  • Empty to inherit the theme
Responsive breakpointresponsive_breakpointProstringDefault: 500px

Viewport width at which the supported layout adapts for narrower screens.

  • A valid CSS length such as 500px
Maximum widthmax_widthProstringDefault: Empty

Optional maximum width for the sitemap container.

  • A valid CSS width
  • Empty for no plugin limit
Section label paddingpost_type_label_paddingProstringDefault: 10px 20px

Optional CSS padding applied to content-type labels.

  • A valid CSS padding value
Section label font sizepost_type_label_font_sizeProstringDefault: Empty

Optional CSS font size applied to content-type labels.

  • A valid CSS font size
  • Empty to inherit the theme
Tab backgroundtab_header_bgProstringDefault: #de5737

Background colour used for sitemap tab controls.

  • A valid CSS colour
Tab text colourtab_colorProstringDefault: #ffffff

Text colour used for sitemap tab controls.

  • A valid CSS colour
Respect SEO noindexrespect_noindexProbooleanDefault: false

Omit content explicitly marked noindex by a supported SEO integration.

  • On
  • Off
Current language onlycurrent_language_onlyProbooleanDefault: false

Limit output to the active language when a supported multilingual plugin is available.

  • On
  • Off
Per-section settingssection_settingsProobjectDefault: Empty array

Store distinct Pro rules for individual Content Sitemap sections.

  • Settings created through the block sidebar

Block · 35 settings

Grouped Sitemap

Free

Group public content beneath taxonomy terms and control term and item ordering.

Grouped Sitemap settings
SettingEditionType and defaultPurpose and accepted values
Unique sitemap IDidFreestringDefault: Empty

Use a stable identifier when more than one similar sitemap appears on a Page.

  • Letters, numbers, hyphens, and underscores
  • Empty for an automatic ID
Page depthpage_depthFreenumberDefault: 0

Limit hierarchical Page output to a specific number of descendant levels.

  • 0 for every level
  • A positive whole number
Taxonomyblock_taxonomyFreestringDefault: category

Select the taxonomy used to group the chosen content type.

  • A taxonomy attached to the selected content type
Title elementtitle_tagFreestringDefault: Empty

Optional HTML element used for the overall sitemap title.

  • h2 to h6
  • div
  • p
  • Empty for no generated title
Show excerptsshow_excerptFreebooleanDefault: false

Display an excerpt beneath each supported item.

  • On
  • Off
Excerpt elementexcerpt_tagFreestringDefault: div

HTML element wrapped around generated excerpts.

  • div
  • p
  • span
Link itemslinksFreebooleanDefault: true

Render sitemap item titles as links to their public URLs.

  • On
  • Off
Order byorderbyFreestringDefault: title

Choose the field used to sort returned items.

  • title
  • date
  • menu_order
  • name
  • ID
  • author
  • comment_count
  • rand where supported
Sort directionorderFreestringDefault: asc

Choose ascending or descending result order.

  • ASC
  • DESC
Section heading elementpost_type_tagFreestringDefault: h3

HTML element used for content-type section headings.

  • h2 to h6
  • div
  • p
Show section labelsshow_labelFreebooleanDefault: true

Display a heading for each selected content type or section.

  • On
  • Off
List elementcontainer_tagFreestringDefault: ul

Choose an unordered or ordered list container.

  • ul
  • ol
Maximum termsnum_termsFreenumberDefault: 0

Limit the number of taxonomy terms displayed.

  • 0 for every eligible term
  • A positive whole number
Enable paginationpaginateFreebooleanDefault: false

Split a large result into bounded linked pages.

  • On
  • Off
Entries per pagepage_sizeFreenumberDefault: 50

Maximum number of items displayed on each generated result page.

  • 1 to 500
Content typeblock_post_typeFreestringDefault: post

Select the public content type whose items are grouped beneath taxonomy terms.

  • A public post-type slug
Term order byterm_orderbyProstringDefault: name

Choose the field used to sort taxonomy terms.

  • name
  • slug
  • term_id
  • count
  • term_order
Term sort directionterm_orderProstringDefault: asc

Choose ascending or descending term order.

  • ASC
  • DESC
Show separatorsseparatorProbooleanDefault: false

Insert a visual separator between supported sitemap items.

  • On
  • Off
Show featured imagesimageProbooleanDefault: false

Display the featured image beside supported sitemap items.

  • On
  • Off
Image sizeimage_sizePronumberDefault: 22

Rendered square image size in pixels.

  • A positive pixel value
Show list iconslist_iconProbooleanDefault: true

Retain the standard list marker or icon treatment.

  • On
  • Off
Include termsinclude_termsProstringDefault: Empty

Include only the selected taxonomy term IDs or slugs.

  • Comma-separated term IDs or supported slugs
  • Empty for all eligible terms
Exclude termsexclude_termsProstringDefault: Empty

Omit the selected taxonomy term IDs or slugs.

  • Comma-separated term IDs or supported slugs
  • Empty for no exclusions
Include private contentvisibilityProbooleanDefault: false

Allow content visible to the current authorised visitor to appear; private content remains permission controlled.

  • On
  • Off
Maximum itemsnum_postsPronumberDefault: -1

Limit the number of content items returned for each section.

  • -1 for no explicit limit
  • 0 or a positive whole number
Add nofollownofollowProbooleanDefault: false

Add rel=nofollow to generated links.

  • On
  • Off
Link taxonomy headingstaxonomy_linksProbooleanDefault: false

Link taxonomy term headings to their public archive pages.

  • On
  • Off
Term heading elementterm_tagProstringDefault: h3

HTML element used for taxonomy term headings.

  • h2 to h6
  • div
  • p
Additional CSS classesrender_classProstringDefault: Empty

Add sanitised CSS classes to the grouped sitemap wrapper.

  • Space-separated CSS class names
  • Empty for none
Section label font sizepost_type_label_font_sizeProstringDefault: Empty

Optional CSS font size applied to content-type labels.

  • A valid CSS font size
  • Empty to inherit the theme
Item line heightsitemap_item_line_heightProstringDefault: Empty

Optional CSS line-height applied to sitemap items.

  • A valid CSS line-height
  • Empty to inherit the theme
Container marginsitemap_container_marginProstringDefault: Empty

Optional CSS margin applied to the sitemap container.

  • A valid CSS margin
  • Empty to inherit the theme
Respect SEO noindexrespect_noindexProbooleanDefault: false

Omit content explicitly marked noindex by a supported SEO integration.

  • On
  • Off
Current language onlycurrent_language_onlyProbooleanDefault: false

Limit output to the active language when a supported multilingual plugin is available.

  • On
  • Off

Block · 15 settings

Child Pages

Free

Show descendants of a selected Page or hierarchical public content item.

Child Pages settings
SettingEditionType and defaultPurpose and accepted values
Parent itemparent_idFreenumberDefault: 0

Select the parent whose descendants are listed.

  • 0 for the current Page where supported
  • A valid content ID
Hierarchy depthdepthFreenumberDefault: 0

Limit the number of hierarchical levels included.

  • 0 for every level
  • A positive whole number
Order byorderbyFreestringDefault: menu_order

Choose the field used to sort returned items.

  • title
  • date
  • menu_order
  • name
  • ID
  • author
  • comment_count
  • rand where supported
Sort directionorderFreestringDefault: asc

Choose ascending or descending result order.

  • ASC
  • DESC
Include IDsincludeProstringDefault: Empty

Include only the exact content or term IDs supplied.

  • Comma-separated positive IDs
  • Empty for no include restriction
Exclude IDsexcludeProstringDefault: Empty

Exclude the exact content or term IDs supplied.

  • Comma-separated positive IDs
  • Empty for no exclusions
Exclude descendantsexclude_descendantsProbooleanDefault: false

Omit descendants of each excluded hierarchical item.

  • On
  • Off
Show excerptsshow_excerptProbooleanDefault: false

Display an excerpt beneath each supported item.

  • On
  • Off
Excerpt lengthexcerpt_lengthPronumberDefault: 25

Maximum number of words shown in Child Pages block excerpts.

  • A positive whole number
Show featured imagesimageProbooleanDefault: false

Display the featured image beside supported sitemap items.

  • On
  • Off
Image sizeimage_sizePronumberDefault: 48

Rendered square image size in pixels.

  • A positive pixel value
Add nofollownofollowProbooleanDefault: false

Add rel=nofollow to generated links.

  • On
  • Off
Content typepost_typeProstringDefault: page

Public post-type slug used by a child, archive, or product query.

  • A public post-type slug
Respect SEO noindexrespect_noindexProbooleanDefault: false

Omit content explicitly marked noindex by a supported SEO integration.

  • On
  • Off
Current language onlycurrent_language_onlyProbooleanDefault: false

Limit output to the active language when a supported multilingual plugin is available.

  • On
  • Off

Block · 11 settings

Taxonomy Terms

Pro

Build a hierarchical list of categories, tags, or another public taxonomy.

Taxonomy Terms settings
SettingEditionType and defaultPurpose and accepted values
TaxonomytaxonomyProstringDefault: category

Taxonomy slug used for the term list or taxonomy archive source.

  • category
  • post_tag
  • Another public taxonomy slug
Include IDsincludeProstringDefault: Empty

Include only the exact content or term IDs supplied.

  • Comma-separated positive IDs
  • Empty for no include restriction
Exclude IDsexcludeProstringDefault: Empty

Exclude the exact content or term IDs supplied.

  • Comma-separated positive IDs
  • Empty for no exclusions
Hierarchy depthdepthPronumberDefault: 0

Limit the number of hierarchical levels included.

  • 0 for every level
  • A positive whole number
Parent IDchild_ofPronumberDefault: 0

List only descendants or terms below this parent ID.

  • 0 for the root level
  • A valid parent ID
List titletitle_liProstringDefault: Empty

Optional title passed to the WordPress hierarchical list renderer.

  • Plain text
  • @ for the linked parent title where supported
  • Empty for no title
Add nofollownofollowProbooleanDefault: false

Add rel=nofollow to generated links.

  • On
  • Off
Show item countsshow_countProbooleanDefault: false

Display the number of matching items beside supported archive or taxonomy links.

  • On
  • Off
Order byorderbyProstringDefault: name

Choose the field used to sort returned items.

  • title
  • date
  • menu_order
  • name
  • ID
  • author
  • comment_count
  • rand where supported
Sort directionorderProstringDefault: ASC

Choose ascending or descending result order.

  • ASC
  • DESC
Hide empty resultshide_emptyProbooleanDefault: false

Omit terms or authors that have no matching public content.

  • On
  • Off

Block · 7 settings

Navigation Menu

Pro

Publish an existing WordPress navigation menu as a sitemap list.

Navigation Menu settings
SettingEditionType and defaultPurpose and accepted values
Navigation menumenuProstringDefault: Empty

Select a WordPress navigation menu by ID, slug, or name.

  • A valid menu ID, slug, or name
Custom labellabelProstringDefault: Empty

Optional heading displayed above the generated list.

  • Plain text
  • Empty for no label
Menu CSS classmenu_classProstringDefault: simple-sitemap-nav-menu

CSS class applied to the generated navigation-menu list.

  • A valid CSS class name
Horizontal separatorhorizontal_separatorProstringDefault: Empty

Text inserted between horizontally displayed items.

  • Plain text or punctuation
  • Empty for no separator
Show list iconslist_iconProbooleanDefault: true

Retain the standard list marker or icon treatment.

  • On
  • Off
Include menu item IDsinclude_menu_idsProstringDefault: Empty

Show only selected navigation menu item IDs.

  • Comma-separated menu item IDs
  • Empty for every item
Exclude menu item IDsexclude_menu_idsProstringDefault: Empty

Omit selected navigation menu item IDs.

  • Comma-separated menu item IDs
  • Empty for no exclusions

Block · 19 settings

WooCommerce Products

Pro

Create a bounded product sitemap filtered by category, stock status, featured state, or exact product IDs.

WooCommerce Products settings
SettingEditionType and defaultPurpose and accepted values
Product layoutlayoutProstringDefault: list

Choose the WooCommerce product sitemap presentation.

  • list
  • grid where available
Product categoriescategory_idsProstringDefault: Empty

Limit products to selected WooCommerce category IDs.

  • Comma-separated product category IDs
  • Empty for every category
Include IDsincludeProstringDefault: Empty

Include only the exact content or term IDs supplied.

  • Comma-separated positive IDs
  • Empty for no include restriction
Exclude IDsexcludeProstringDefault: Empty

Exclude the exact content or term IDs supplied.

  • Comma-separated positive IDs
  • Empty for no exclusions
Order byorderbyProstringDefault: title

Choose the field used to sort returned items.

  • title
  • date
  • menu_order
  • name
  • ID
  • author
  • comment_count
  • rand where supported
Sort directionorderProstringDefault: ASC

Choose ascending or descending result order.

  • ASC
  • DESC
Maximum resultslimitPronumberDefault: 50

Bound the number of archive links or WooCommerce products returned.

  • A positive whole number
  • Archive Links accepts 1 to 100
Stock statusstock_statusProstringDefault: any

Limit products by their current WooCommerce stock status.

  • any
  • instock
  • outofstock
  • onbackorder
Featured products onlyfeatured_onlyProbooleanDefault: false

Include only products marked as featured in WooCommerce.

  • On
  • Off
Custom labellabelProstringDefault: Empty

Optional heading displayed above the generated list.

  • Plain text
  • Empty for no label
Heading levelheading_levelPronumberDefault: 2

Choose the semantic heading level used for the optional label.

  • 2 to 6
Show priceshow_priceProbooleanDefault: true

Display the current WooCommerce product price.

  • On
  • Off
Show SKUshow_skuProbooleanDefault: false

Display the product SKU when one is available.

  • On
  • Off
Show excerptsshow_excerptProbooleanDefault: false

Display an excerpt beneath each supported item.

  • On
  • Off
Show product imagesshow_imageProbooleanDefault: false

Display WooCommerce product images in the sitemap.

  • On
  • Off
Image sizeimage_sizePronumberDefault: 48

Rendered square image size in pixels.

  • A positive pixel value
Add nofollownofollowProbooleanDefault: false

Add rel=nofollow to generated links.

  • On
  • Off
Respect SEO noindexrespect_noindexProbooleanDefault: false

Omit content explicitly marked noindex by a supported SEO integration.

  • On
  • Off
Current language onlycurrent_language_onlyProbooleanDefault: false

Limit output to the active language when a supported multilingual plugin is available.

  • On
  • Off

Established workflows

Shortcode attributes

Shortcodes remain supported for existing content and code-led builds. Add only attributes whose defaults you need to change.

Shortcode · 39 attributes

[simple-sitemap]

Free

List Pages, posts, or other public content types.

Aliases: [ss]

[simple-sitemap]
[simple-sitemap] attributes
AttributeEditionType and defaultPurpose and accepted values
Unique sitemap IDidFreestringDefault: Empty

Use a stable identifier when more than one similar sitemap appears on a Page.

  • Letters, numbers, hyphens, and underscores
  • Empty for an automatic ID
Page depthpage_depthFreenumberDefault: 0

Limit hierarchical Page output to a specific number of descendant levels.

  • 0 for every level
  • A positive whole number
Order byorderbyFreestringDefault: title

Choose the field used to sort returned items.

  • title
  • date
  • menu_order
  • name
  • ID
  • author
  • comment_count
  • rand where supported
Sort directionorderFreestringDefault: asc

Choose ascending or descending result order.

  • ASC
  • DESC
Show excerptsshow_excerptFreebooleanDefault: false

Display an excerpt beneath each supported item.

  • On
  • Off
Show section labelsshow_labelFreebooleanDefault: true

Display a heading for each selected content type or section.

  • On
  • Off
Link itemslinksFreebooleanDefault: true

Render sitemap item titles as links to their public URLs.

  • On
  • Off
Open links in a new tabtarget_blankFreebooleanDefault: false

Open generated sitemap links in a new browser tab.

  • On
  • Off
Include IDsincludeFreestringDefault: Empty

Include only the exact content or term IDs supplied.

  • Comma-separated positive IDs
  • Empty for no include restriction
Exclude IDsexcludeFreestringDefault: Empty

Exclude the exact content or term IDs supplied.

  • Comma-separated positive IDs
  • Empty for no exclusions
Enable paginationpaginateFreebooleanDefault: false

Split a large result into bounded linked pages.

  • On
  • Off
Entries per pagepage_sizeFreenumberDefault: 50

Maximum number of items displayed on each generated result page.

  • 1 to 500
Title elementtitle_tagFreestringDefault: Empty

Optional HTML element used for the overall sitemap title.

  • h2 to h6
  • div
  • p
  • Empty for no generated title
Section heading elementpost_type_tagFreestringDefault: h3

HTML element used for content-type section headings.

  • h2 to h6
  • div
  • p
Excerpt elementexcerpt_tagFreestringDefault: div

HTML element wrapped around generated excerpts.

  • div
  • p
  • span
List elementcontainer_tagFreestringDefault: ul

Choose an unordered or ordered list container.

  • ul
  • ol
Layout moderenderFreestringDefault: Empty

Choose the standard list or tabbed shortcode presentation.

  • Empty for a standard list
  • tab
Content typestypesFreestringDefault: page

Comma-separated public post-type slugs included in the sitemap.

  • One or more public post-type slugs
Exclude descendantsexclude_childProbooleanDefault: false

When an excluded Page is hierarchical, omit its descendants as well.

  • On
  • Off
Show featured imagesimageProbooleanDefault: false

Display the featured image beside supported sitemap items.

  • On
  • Off
Image sizeimage_sizePronumberDefault: 22

Rendered square image size in pixels.

  • A positive pixel value
Show list iconslist_iconProbooleanDefault: true

Retain the standard list marker or icon treatment.

  • On
  • Off
Show separatorsseparatorProbooleanDefault: false

Insert a visual separator between supported sitemap items.

  • On
  • Off
Horizontal layouthorizontalProbooleanDefault: false

Display content items in a compact horizontal flow.

  • On
  • Off
Horizontal separatorhorizontal_separatorProstringDefault: ,

Text inserted between horizontally displayed items.

  • Plain text or punctuation
  • Empty for no separator
Add nofollownofollowProbooleanDefault: false

Add rel=nofollow to generated links.

  • On
  • Off
Maximum itemsnum_postsPronumberDefault: -1

Limit the number of content items returned for each section.

  • -1 for no explicit limit
  • 0 or a positive whole number
Include private contentvisibilityProbooleanDefault: false

Allow content visible to the current authorised visitor to appear; private content remains permission controlled.

  • On
  • Off
Excerpt lengthpage_excerpt_lengthPronumberDefault: 25

Maximum number of words shown in shortcode or Content Sitemap excerpts.

  • A positive whole number
Item line heightsitemap_item_line_heightProstringDefault: Empty

Optional CSS line-height applied to sitemap items.

  • A valid CSS line-height
  • Empty to inherit the theme
Container marginsitemap_container_marginProstringDefault: Empty

Optional CSS margin applied to the sitemap container.

  • A valid CSS margin
  • Empty to inherit the theme
Responsive breakpointresponsive_breakpointProstringDefault: 500px

Viewport width at which the supported layout adapts for narrower screens.

  • A valid CSS length such as 500px
Maximum widthmax_widthProstringDefault: Empty

Optional maximum width for the sitemap container.

  • A valid CSS width
  • Empty for no plugin limit
Section label paddingpost_type_label_paddingProstringDefault: 10px 20px

Optional CSS padding applied to content-type labels.

  • A valid CSS padding value
Section label font sizepost_type_label_font_sizeProstringDefault: Empty

Optional CSS font size applied to content-type labels.

  • A valid CSS font size
  • Empty to inherit the theme
Tab backgroundtab_header_bgProstringDefault: #de5737

Background colour used for sitemap tab controls.

  • A valid CSS colour
Tab text colourtab_colorProstringDefault: #ffffff

Text colour used for sitemap tab controls.

  • A valid CSS colour
Respect SEO noindexrespect_noindexProbooleanDefault: false

Omit content explicitly marked noindex by a supported SEO integration.

  • On
  • Off
Current language onlycurrent_language_onlyProbooleanDefault: false

Limit output to the active language when a supported multilingual plugin is available.

  • On
  • Off

Shortcode · 35 attributes

[simple-sitemap-group]

Free

Group content beneath terms from a selected taxonomy.

Aliases: [ssg]

[simple-sitemap-group]
[simple-sitemap-group] attributes
AttributeEditionType and defaultPurpose and accepted values
Unique sitemap IDidFreestringDefault: Empty

Use a stable identifier when more than one similar sitemap appears on a Page.

  • Letters, numbers, hyphens, and underscores
  • Empty for an automatic ID
Page depthpage_depthFreenumberDefault: 0

Limit hierarchical Page output to a specific number of descendant levels.

  • 0 for every level
  • A positive whole number
TaxonomytaxFreestringDefault: category

Taxonomy slug used to group shortcode results.

  • category
  • post_tag
  • Another public taxonomy slug
Title elementtitle_tagFreestringDefault: Empty

Optional HTML element used for the overall sitemap title.

  • h2 to h6
  • div
  • p
  • Empty for no generated title
Show excerptsshow_excerptFreebooleanDefault: false

Display an excerpt beneath each supported item.

  • On
  • Off
Excerpt elementexcerpt_tagFreestringDefault: div

HTML element wrapped around generated excerpts.

  • div
  • p
  • span
Link itemslinksFreebooleanDefault: true

Render sitemap item titles as links to their public URLs.

  • On
  • Off
Order byorderbyFreestringDefault: title

Choose the field used to sort returned items.

  • title
  • date
  • menu_order
  • name
  • ID
  • author
  • comment_count
  • rand where supported
Sort directionorderFreestringDefault: asc

Choose ascending or descending result order.

  • ASC
  • DESC
Section heading elementpost_type_tagFreestringDefault: h3

HTML element used for content-type section headings.

  • h2 to h6
  • div
  • p
Show section labelsshow_labelFreebooleanDefault: true

Display a heading for each selected content type or section.

  • On
  • Off
List elementcontainer_tagFreestringDefault: ul

Choose an unordered or ordered list container.

  • ul
  • ol
Maximum termsnum_termsFreenumberDefault: 0

Limit the number of taxonomy terms displayed.

  • 0 for every eligible term
  • A positive whole number
Enable paginationpaginateFreebooleanDefault: false

Split a large result into bounded linked pages.

  • On
  • Off
Entries per pagepage_sizeFreenumberDefault: 50

Maximum number of items displayed on each generated result page.

  • 1 to 500
Grouped content typetypeProstringDefault: post

Public post-type slug whose items are grouped by the selected taxonomy in the grouped shortcode.

  • A public post-type slug
Term order byterm_orderbyProstringDefault: name

Choose the field used to sort taxonomy terms.

  • name
  • slug
  • term_id
  • count
  • term_order
Term sort directionterm_orderProstringDefault: asc

Choose ascending or descending term order.

  • ASC
  • DESC
Show separatorsseparatorProbooleanDefault: false

Insert a visual separator between supported sitemap items.

  • On
  • Off
Show featured imagesimageProbooleanDefault: false

Display the featured image beside supported sitemap items.

  • On
  • Off
Image sizeimage_sizePronumberDefault: 22

Rendered square image size in pixels.

  • A positive pixel value
Show list iconslist_iconProbooleanDefault: true

Retain the standard list marker or icon treatment.

  • On
  • Off
Include termsinclude_termsProstringDefault: Empty

Include only the selected taxonomy term IDs or slugs.

  • Comma-separated term IDs or supported slugs
  • Empty for all eligible terms
Exclude termsexclude_termsProstringDefault: Empty

Omit the selected taxonomy term IDs or slugs.

  • Comma-separated term IDs or supported slugs
  • Empty for no exclusions
Include private contentvisibilityProbooleanDefault: false

Allow content visible to the current authorised visitor to appear; private content remains permission controlled.

  • On
  • Off
Maximum itemsnum_postsPronumberDefault: -1

Limit the number of content items returned for each section.

  • -1 for no explicit limit
  • 0 or a positive whole number
Add nofollownofollowProbooleanDefault: false

Add rel=nofollow to generated links.

  • On
  • Off
Link taxonomy headingstaxonomy_linksProbooleanDefault: false

Link taxonomy term headings to their public archive pages.

  • On
  • Off
Term heading elementterm_tagProstringDefault: h3

HTML element used for taxonomy term headings.

  • h2 to h6
  • div
  • p
Additional CSS classesrender_classProstringDefault: Empty

Add sanitised CSS classes to the grouped sitemap wrapper.

  • Space-separated CSS class names
  • Empty for none
Section label font sizepost_type_label_font_sizeProstringDefault: Empty

Optional CSS font size applied to content-type labels.

  • A valid CSS font size
  • Empty to inherit the theme
Item line heightsitemap_item_line_heightProstringDefault: Empty

Optional CSS line-height applied to sitemap items.

  • A valid CSS line-height
  • Empty to inherit the theme
Container marginsitemap_container_marginProstringDefault: Empty

Optional CSS margin applied to the sitemap container.

  • A valid CSS margin
  • Empty to inherit the theme
Respect SEO noindexrespect_noindexProbooleanDefault: false

Omit content explicitly marked noindex by a supported SEO integration.

  • On
  • Off
Current language onlycurrent_language_onlyProbooleanDefault: false

Limit output to the active language when a supported multilingual plugin is available.

  • On
  • Off

Shortcode · 8 attributes

[simple-sitemap-child]

Pro

List descendants of one Page or hierarchical content item.

Aliases: [ssc]

[simple-sitemap-child]
[simple-sitemap-child] attributes
AttributeEditionType and defaultPurpose and accepted values
Include IDsincludeProstringDefault: Empty

Include only the exact content or term IDs supplied.

  • Comma-separated positive IDs
  • Empty for no include restriction
Exclude IDsexcludeProstringDefault: Empty

Exclude the exact content or term IDs supplied.

  • Comma-separated positive IDs
  • Empty for no exclusions
Parent IDchild_ofPronumberDefault: 0

List only descendants or terms below this parent ID.

  • 0 for the root level
  • A valid parent ID
List titletitle_liProstringDefault: Empty

Optional title passed to the WordPress hierarchical list renderer.

  • Plain text
  • @ for the linked parent title where supported
  • Empty for no title
Add nofollownofollowProbooleanDefault: false

Add rel=nofollow to generated links.

  • On
  • Off
Content typepost_typeProstringDefault: page

Public post-type slug used by a child, archive, or product query.

  • A public post-type slug
Show excerptsshow_excerptProbooleanDefault: false

Display an excerpt beneath each supported item.

  • On
  • Off
Excerpt lengthpage_excerpt_lengthPronumberDefault: 25

Maximum number of words shown in shortcode or Content Sitemap excerpts.

  • A positive whole number

Shortcode · 12 attributes

[simple-sitemap-tax]

Pro

List categories, tags, or terms from another taxonomy.

Aliases: [sst]

[simple-sitemap-tax]
[simple-sitemap-tax] attributes
AttributeEditionType and defaultPurpose and accepted values
TaxonomytaxonomyProstringDefault: category

Taxonomy slug used for the term list or taxonomy archive source.

  • category
  • post_tag
  • Another public taxonomy slug
Include IDsincludeProstringDefault: Empty

Include only the exact content or term IDs supplied.

  • Comma-separated positive IDs
  • Empty for no include restriction
Exclude IDsexcludeProstringDefault: Empty

Exclude the exact content or term IDs supplied.

  • Comma-separated positive IDs
  • Empty for no exclusions
Hierarchy depthdepthPronumberDefault: 0

Limit the number of hierarchical levels included.

  • 0 for every level
  • A positive whole number
Parent IDchild_ofPronumberDefault: 0

List only descendants or terms below this parent ID.

  • 0 for the root level
  • A valid parent ID
List titletitle_liProstringDefault: Empty

Optional title passed to the WordPress hierarchical list renderer.

  • Plain text
  • @ for the linked parent title where supported
  • Empty for no title
Add nofollownofollowProbooleanDefault: false

Add rel=nofollow to generated links.

  • On
  • Off
Show item countsshow_countProbooleanDefault: 0

Display the number of matching items beside supported archive or taxonomy links.

  • On
  • Off
Order byorderbyProstringDefault: name

Choose the field used to sort returned items.

  • title
  • date
  • menu_order
  • name
  • ID
  • author
  • comment_count
  • rand where supported
Sort directionorderProstringDefault: ASC

Choose ascending or descending result order.

  • ASC
  • DESC
Hide empty resultshide_emptyProbooleanDefault: 0

Omit terms or authors that have no matching public content.

  • On
  • Off
Echo outputechoProbooleanDefault: 0

Legacy compatibility attribute; the shortcode always returns its HTML for safe placement.

  • 0
  • false

Shortcode · 9 attributes

[simple-sitemap-menu]

Pro

Render an existing WordPress navigation menu as a sitemap.

Aliases: [ssm]

[simple-sitemap-menu]
[simple-sitemap-menu] attributes
AttributeEditionType and defaultPurpose and accepted values
Navigation menumenuProstringDefault: Empty

Select a WordPress navigation menu by ID, slug, or name.

  • A valid menu ID, slug, or name
Menu containercontainerProbooleanDefault: false

Legacy wp_nav_menu container option retained for shortcode compatibility.

  • false
  • A supported wp_nav_menu container value
Menu CSS classmenu_classProstringDefault: simple-sitemap-nav-menu

CSS class applied to the generated navigation-menu list.

  • A valid CSS class name
Horizontal separatorhorizontal_separatorProstringDefault: ,

Text inserted between horizontally displayed items.

  • Plain text or punctuation
  • Empty for no separator
Show list iconslist_iconProbooleanDefault: true

Retain the standard list marker or icon treatment.

  • On
  • Off
Container CSS classcontainer_classProstringDefault: Empty

CSS class applied to the optional menu container.

  • A valid CSS class name
  • Empty for none
Custom labellabelProstringDefault: Empty

Optional heading displayed above the generated list.

  • Plain text
  • Empty for no label
Exclude menu item IDsexclude_menu_idsProstringDefault: Empty

Omit selected navigation menu item IDs.

  • Comma-separated menu item IDs
  • Empty for no exclusions
Include menu item IDsinclude_menu_idsProstringDefault: Empty

Show only selected navigation menu item IDs.

  • Comma-separated menu item IDs
  • Empty for every item

WordPress options

Plugin settings

These retained options matter mainly to established installations. New block-first sites will rarely need to change them.

Retained plugin settings
SettingEditionType and defaultPurpose and accepted values
Link parent Page headingschk_parent_page_linkFreebooleanDefault: false

Link a parent Page heading to that Page when the legacy parent-page output is used.

  • On
  • Off
Excluded parent Page IDstxt_exclude_parent_pagesFreestringDefault: Empty

Comma-separated Page IDs omitted from the legacy parent-page output.

  • Comma-separated positive Page IDs
  • Empty for no exclusions
Custom sitemap CSStxtar_sitemap_scriptFreestringDefault: Empty

Optional CSS stored by established installations for sitemap presentation.

  • Valid CSS
  • Empty to use theme and plugin styles