Surerank

https://surerank.com/docs/
Admin
Surerank provides comprehensive search engine optimization documentation, covering features,...
Tokens:61,051
Snippets:1,115
Trust Score:7.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Combined Shortcode Configuration

Source: https://surerank.com/docs/breadcrumbs

Example of using multiple shortcode attributes simultaneously.

```shortcode
[surerank_breadcrumbs
    separator="»"
    home_label="Home"
    prefix="Navigation:"
    hide_post_title="false"
    show_blog_page="true"
]
```

--------------------------------

### Example Robots.txt File Content

Source: https://surerank.com/docs/surerank-robots-txt-file

A standard robots.txt configuration generated by SureRank, showing user-agent directives and sitemap location.

```text
User-agent: *  
 Disallow: /wp-admin/  
Allow: /wp-admin/admin-ajax.php  
Sitemap: https://yourwebsite.com/sitemap.xml
```

--------------------------------

### FAQ Schema JSON-LD Example

Source: https://surerank.com/docs/how-to-add-custom-schema-in-surerank

A sample JSON-LD structure for an FAQPage that can be pasted into the SureRank custom schema editor.

```json
{
  "@context": "https://schema.org",
  "@type": "FAQPage",
  "mainEntity": [
    {
      "@type": "Question",
      "name": "What is SureRank?",
      "acceptedAnswer": {
        "@type": "Answer",
        "text": "SureRank is a WordPress SEO plugin built for speed and simplicity."
      }
    },
    {
      "@type": "Question",
      "name": "Does SureRank support schema markup?",
      "acceptedAnswer": {
        "@type": "Answer",
        "text": "Yes. SureRank supports multiple schema types including FAQ, Article, Product, and more."
      }
    }
  ]
}
```

--------------------------------

### Default WordPress-Friendly Robots.txt Configuration

Source: https://surerank.com/docs/robots-txt-feature-in-surerank

Standard configuration to allow necessary AJAX functionality while blocking the WordPress admin dashboard.

```text
User-agent: *
Disallow: /wp-admin/
Allow: /wp-admin/admin-ajax.php
```

--------------------------------

### Modify Search Results Title with surerank_search_title

Source: https://surerank.com/docs/surerank_search_title

Use this filter to override the default search results title. This example removes the search query from the output.

```php
// Modify the default search results title in SureRank (removes the search query)
add_filter( 'surerank_search_title', function( $title ) {
    return 'Search Results:'; // Custom title without the search query
});
```

--------------------------------

### Enable pagination in SureRank archives

Source: https://surerank.com/docs/surerank_show_pagination

Use this filter to append pagination details to the SEO title by returning true.

```php
// Enable pagination on archive pages managed by SureRank
add_filter( 'surerank_show_pagination', '__return_true' );
```

```php
// Enable pagination on archive pages managed by SureRank
add_filter( 'surerank_show_pagination', '__return_true' );
```

--------------------------------

### Set Custom Archive Format

Source: https://surerank.com/docs/breadcrumbs

Define the display format for archive page breadcrumbs using %s as a placeholder.

```shortcode
[surerank_breadcrumbs archive_format="Archive: %s"]
```

--------------------------------

### Display Basic Breadcrumbs via Shortcode

Source: https://surerank.com/docs/breadcrumbs

The default shortcode to render breadcrumbs on a page or post.

```shortcode
[surerank_breadcrumbs]
```

--------------------------------

### Control Shop Page in Permalink

Source: https://surerank.com/docs/breadcrumbs

Determines whether the shop page is included in the product breadcrumb path.

```php
add_filter( 'surerank_breadcrumbs_shop_in_permalink', function( $has_shop, $shop_page ) {
    // Always show shop page in product breadcrumbs
    return true;
}, 10, 2 );
```

--------------------------------

### Regenerate Sitemap via WP-CLI

Source: https://surerank.com/docs/how-to-regenerate-the-sitemap-after-excluding-a-post-type-in-surerank

Use this command to immediately force a sitemap regeneration, bypassing the daily cron schedule.

```bash
wp surerank generate_cache
```

--------------------------------

### Default Robots.txt Configuration

Source: https://surerank.com/docs/how-to-fix-robots-txt-file-accessibility-issues-in-surerank

A standard robots.txt configuration that allows search engines to crawl the site while restricting access to the WordPress admin area.

```text
User-agent: *
Disallow: /wp-admin/
Allow: /wp-admin/admin-ajax.php
Sitemap: https://yourwebsite.com/sitemap_index.xml
```

```text
User-agent: *
Disallow: /wp-admin/
Allow: /wp-admin/admin-ajax.php
Sitemap: https://yourwebsite.com/sitemap_index.xml
```

--------------------------------

### Set Custom Home Label

Source: https://surerank.com/docs/breadcrumbs

Change the label for the home breadcrumb item.

```shortcode
[surerank_breadcrumbs home_label="Start"]
```

--------------------------------

### Add Breadcrumb Prefix

Source: https://surerank.com/docs/breadcrumbs

Include a text prefix before the breadcrumb trail.

```shortcode
[surerank_breadcrumbs prefix="You are here:"]
```

--------------------------------

### Set Custom Search Format

Source: https://surerank.com/docs/breadcrumbs

Define the display format for search result breadcrumbs using %s as a placeholder.

```shortcode
[surerank_breadcrumbs search_format="Search: %s"]
```

--------------------------------

### Enable External Links in New Tab

Source: https://surerank.com/docs/open-external-links-in-new-tab-surerank_open_external_links_in_new_tab

Use this filter to globally enable the target="_blank" attribute for external links.

```php
add_filter( 'surerank_open_external_links_in_new_tab', '__return_true' );
```

--------------------------------

### Set Custom 404 Label

Source: https://surerank.com/docs/breadcrumbs

Define the label used when the breadcrumb is displayed on a 404 page.

```shortcode
[surerank_breadcrumbs 404_label="Page Not Found"]
```

--------------------------------

### Redirect non-www to www

Source: https://surerank.com/docs/fix-www-non-www-redirects

Enforces a www URL structure by prepending the www prefix to the domain and performing a 301 permanent redirect.

```apache
RewriteEngine On
RewriteCond %{HTTP_HOST} !^www\. [NC]
RewriteRule ^ https://www.%{HTTP_HOST}%{REQUEST_URI} [L,R=301]
```

```apache
RewriteEngine On
RewriteCond %{HTTP_HOST} !^www\. [NC]
RewriteRule ^ https://www.%{HTTP_HOST}%{REQUEST_URI} [L,R=301]
```

--------------------------------

### Customize Homepage Pagination Format with PHP

Source: https://surerank.com/docs/surerank_homepage_pagination_format

Use this filter to change the default pagination label. The return value should include a %s placeholder for the page number.

```php
// Customize the pagination format on the homepage to display as "Page X"
add_filter( 'surerank_homepage_pagination_format', 'custom_homepage_pagination_format' );

function custom_homepage_pagination_format() {
    return 'Page %s';
}
```

```php
// Customize the pagination format on the homepage to display as "Page X"
add_filter( 'surerank_homepage_pagination_format', 'custom_homepage_pagination_format' );

function custom_homepage_pagination_format() {
    return 'Page %s';
}
```

--------------------------------

### Disable Schema Markup

Source: https://surerank.com/docs/breadcrumbs

Toggle the inclusion of JSON-LD schema markup for breadcrumbs.

```shortcode
[surerank_breadcrumbs enable_schema="false"]
```

--------------------------------

### Modify All Breadcrumb Settings at Runtime

Source: https://surerank.com/docs/breadcrumbs

Use the surerank_breadcrumbs_settings filter to override global breadcrumb configuration options.

```php
add_filter( 'surerank_breadcrumbs_settings', function( $settings ) {
    // Change separator
    $settings['separator'] = ' / ';

    // Change home label
    $settings['home_label'] = 'Start';

    // Add prefix
    $settings['prefix'] = 'Navigate: ';

    // Hide post title on single posts
    if ( is_single() ) {
        $settings['hide_post_title'] = true;
    }

    return $settings;
} );
```

--------------------------------

### Hide Home Crumb

Source: https://surerank.com/docs/breadcrumbs

Toggle the visibility of the home link in the breadcrumb trail.

```shortcode
[surerank_breadcrumbs show_home="false"]
```

--------------------------------

### Enable noindex for paginated pages

Source: https://surerank.com/docs/surerank_noindex_paginated_pages

Use this filter to output a noindex meta tag on paginated archive pages by returning true.

```php
// Enable noindex for paginated pages to prevent indexing of duplicate content.
add_filter( 'surerank_noindex_paginated_pages', '__return_true' );
```

```php
// Enable noindex for paginated pages to prevent indexing of duplicate content.
add_filter( 'surerank_noindex_paginated_pages', '__return_true' );
```

--------------------------------

### Remove Product Category Base in PHP

Source: https://surerank.com/docs/surerank_remove_product_category_base

Use this filter to enable the removal of the product-category base. Ensure permalink settings are flushed after implementation.

```PHP
// Enable the option to remove the 'product-category' base from product category URLs in SureRank
add_filter( 'surerank_remove_product_category_base', '__return_true' );
```

```PHP
// Enable the option to remove the 'product-category' base from product category URLs in SureRank
add_filter( 'surerank_remove_product_category_base', '__return_true' );
```

--------------------------------

### add_filter( 'surerank_show_site_name', ... )

Source: https://surerank.com/docs/surerank_show_site_name

Use this filter to toggle the site name visibility in the SEO title. Returning false will remove the site name from the generated title.

```APIDOC
## Hook: surerank_show_site_name

### Description
This filter allows developers to control whether the site name should be included in the generated SEO title. By default, the site name is appended to the page title. Returning `false` disables this behavior.

### Usage
```php
// Disable showing the site name in the meta title generated by SureRank.
add_filter( 'surerank_show_site_name', '__return_false' );
```
```
Tokens:
Raw