Simple Sitemap Pro Documentation

Last updated by David on February 17, 2017 13:21

After purchase you can download the plugin zip file from your WPGO Plugins account area. Complete the following steps to install Simple Sitemap Pro on your site:

  1. On the site you wish to install the plugin go to the WordPress admin dashboard and click the Plugins link in the left hand menu.
  2. At the top of the Plugins list page click the Add New button, and then on the next page click the Upload Plugin button.
  3. You’ll now see a Choose File button. Click it and select the plugin zip file you downloaded to your computer earlier.
  4. Once the plugin has been selected click the Install Now button to begin the installation process.
  5. In a few seconds you should see a Plugin installed successfully message. Click the Activate Plugin link underneath to make the plugin ready for use.

Once installed and activated go to Settings > Simple Sitemap Pro to access plugin settings. There are two tabs to navigate the various settings. The Simple Sitemap Shortcodes tab is selected by default and contains the necessary information on how to use the shortcodes included with the plugin.

Simple Sitemap Plugin Tabs

[simple-sitemap] Shortcode

Use this shortcode to display a sitemap of different post types.

Note: Shortcode with no attributes outputs a list of posts for each post type: [simple-sitemap]

There are many attributes you can use to customize the look of your sitemap. Attributes can be combined as required for an even more flexible sitemap layout.

  1. Render the sitemap in a tabbed layout. Each tab contains a separate post type:
    [simple-sitemap render='tab']
  2. Specify the type and order of post types:
    [simple-sitemap types='post, page']
  3. Set page depth (i.e. indentation) for nested posts:
    [simple-sitemap page_depth='1']
  4. Wrap each sitemap entry in a specific HTML tag:
    [simple-sitemap title_tag='h3']
  5. Wrap the post type label in a specific HTML tag:
    [simple-sitemap post_type_tag='h2']
  6. Order posts for each post type via title, date, ID etc. See full list of options here: https://codex.wordpress.org/Class_Reference/WP_Query#Order_.26_Orderby_Parameters
    [simple-sitemap orderby='title']
  7. Whatever the ‘orderby’ attribute is set to the ‘order’ attribute will sort them in either ascending or descending:
    [simple-sitemap order='asc|desc']
  8. Optionally show a post excerpt for each sitemap entry:
    [simple-sitemap excerpt='true|false']
  9. HTML tag to wrap the excerpt (if displayed):
    [simple-sitemap excerpt_tag='span']
  10. Comma separated list of post/page ID’s to exclude from the sitemap:
    [simple-sitemap exclude='1,2,3,4']
  11. Show the label for each post type:
    [simple-sitemap show_label='true|false']
  12. Display sitemap items as links or plain text:
    [simple-sitemap links='true|false']
  13. Display the post featured image (if defined) next to each sitemap item as an icon:
    [simple-sitemap image='true|false']
  14. Display the sitemap items with or without bullet points:
    [simple-sitemap list_icon='true|false']
  15. Show a separator between sitemap items:
    [simple-sitemap separator='true|false']
  16. If multiple tabbed sitemaps are to be displayed then this attribute is useful to avoid CSS id conflicts:
    [simple-sitemap id='999']
  17. The sitemap can now also be show as a continuous horizontal list (separate list for each post type):
    [simple-sitemap horizontal='true']
    Note: For this to work the render attribute needs to be empty (which it is by default).
  18. You can customize the horizontal list separator too:
    [simple-sitemap horizontal='true' horizontal_separator=' | ']
    Note: For this to work the horizontal attribute needs to be set to true.

Here’s a full list of attributes for the [simple-sitemap] shortcode with default values:

  • render=''
  • types='post, page'
  • page_depth='0'
  • title_tag=''
  • post_type_tag='h3'
  • orderby='title'
  • order='asc'
  • excerpt='false'
  • excerpt_tag='span'
  • exclude=''
  • show_label='true'
  • links='true'
  • image='false'
  • list_icon='true'
  • separator='false'
  • id='1'
  • horizontal='false'
  • horizontal_separator=', '

[simple-sitemap-group] Shortcode

Use this shortcode to display a sitemap for a single post type showing posts grouped by taxonomy terms.

Note: Shortcode with no attributes outputs a list of posts grouped by taxonomy: [simple-sitemap-group]

There are many attributes you can use to customize the look of your sitemap. Attributes can be combined as required for an even more flexible sitemap layout.

  1. Select post type:
    [simple-sitemap-group type='post']
  2. Select post taxonomy:
    [simple-sitemap-group tax='category']
  3. Wrap each sitemap entry in a specific HTML tag:
    [simple-sitemap-group title_tag='h3']
  4. Optionally show a post excerpt for each sitemap entry:
    [simple-sitemap-group excerpt='true|false']
  5. HTML tag to wrap the excerpt (if displayed):
    [simple-sitemap-group excerpt_tag='span']
  6. Display sitemap items as links or plain text:
    [simple-sitemap-group links='true|false']
  7. Show a separator between sitemap items:
    [simple-sitemap-group separator='true|false']
  8. Display the post featured image (if defined) next to each sitemap item as an icon:
    [simple-sitemap-group image='true|false']
  9. Order posts for each post type via title, date, ID etc. See full list of options here: https://codex.wordpress.org/Class_Reference/WP_Query#Order_.26_Orderby_Parameters
    [simple-sitemap-group orderby='title']
  10. Whatever the ‘orderby’ attribute is set to the ‘order’ attribute will sort them in either ascending or descending:
    [simple-sitemap-group order='asc|desc']
  11. Display the sitemap items with or without bullet points:
    [simple-sitemap-group list_icon='true|false']
  12. Order post taxonmy term labels by name, date etc.
    [simple-sitemap-group term_orderby='title']
  13. Whatever the ‘term_orderby’ attribute is set to the ‘term_order’ attribute will sort them in either ascending or descending:
    [simple-sitemap-group term_order='asc|desc']
  14. Comma separated list of taxonomy terms (e.g. categories) to exclude from the sitemap:
    [simple-sitemap-group exclude_terms="term1, term2"]
  15. Comma separated list of post/page ID’s to exclude from the sitemap:
    [simple-sitemap-group exclude='1,2,3,4']
  16. Wrap the post type label in a specific HTML tag:
    [simple-sitemap-group post_type_tag='h2']
  17. Show the label for the post type:
    [simple-sitemap-group show_label='true|false']

Here’s a full list of attributes for the [simple-sitemap-group] shortcode with default values:

  • type='post'
  • tax='category'
  • title_tag=''
  • excerpt='false'
  • excerpt_tag='div'
  • links='true'
  • separator='false'
  • image='false'
  • orderby='title'
  • order='asc'
  • list_icon='true'
  • term_orderby='name'
  • term_order='asc'
  • exclude=''
  • exclude_terms=''
  • post_type_tag='h3'
  • show_label='true'

To remove ALL parent page links, and just leave the sitemap titles as plain text, simply check the Remove parent page links? checkbox as demonstrated below.

You can also remove links for specific parent pages only. To do this check the Remove parent page links? box again and then specify a comma separated list of parent page IDs you want to remove the links for.

Note: If you specify an ID for a different post type or for a page that isn’t a parent then it will be ignored.

Plugin Filters

Filter: simple_sitemap_pro_title_text

Description: Filters post titles so that long titles can be shortened for specific posts.

Usage:

function filter_title_text($title_text) {

	// Note: The titles are case sensitive so make sure you match the title exactly!
	if( $title_text == 'Long Post Title We Want to Shorten' )
		$title_text = 'Shorter Title';

	if( $title_text == 'Another Long Post Title That Needs Shortening!' )
		$title_text = 'Another Shorter Title';

	// If you have a lot of titles to shorten this code may be more suitable
	switch ($title_text) {
		case "Long Post Title #1 We Want To Shorten":
			$title_text = "Shorter Title #1";
			break;
		case "Long Post Title #2 We Want To Shorten":
			$title_text = "Shorter Title #2";
			break;
		case "Long Post Title #3 We Want To Shorten":
			$title_text = "Shorter Title #3";
			break;
	}

	return $title_text;
}
add_filter( 'simple_sitemap_pro_title_text', 'filter_title_text' );

License and Support

Click on the License & Support tab for links to your WPGO Plugins account page, plugin support, and documentation. You can also enter your plugin license key for access to future plugin updates directly from the WordPress admin.

Simple Sitemap Pro License Options

Still Have Questions?

We’d love to hear from you! If there’s any aspect of the plugin that you need help with or have any suggestions then please get in touch. You can contact us directly here.

First published January 20, 2016