Slack

Join the #yoast-seo-for-typo3 channel on the TYPO3 Slack.

If you are not registered yet, find out more about how to join.

Github

Found a bug in the extension? Please report this in our Github repository.

Access rights

Through the "Access lists" of backend users and groups it's possible to configure access for:

• All the Yoast SEO fields within pages
• The backend modules
• The Dashboard widgets

Enable snippet preview on specific page types

By default, the snippet preview is only shown on pages with doktype 1 (Standard page) and 6 (Backend user section). You can add your own doktypes like the example below by adding a doktype to the $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['yoast_seo']['allowedDoktypes'] array in the ext_localconf.php of your own extension.

$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['yoast_seo']['allowedDoktypes']['blog'] = 137;

The key can be any unique string. It is only used to identify the doktype as a developer. The value contains the numeric value of the doktype.

Disable snippet preview with PageTs

Sometimes only a check on doktype isn't enough for disabling the snippet preview. For example if you want to hide the snippet preview on detail pages of for example a news item, you need more than a check on a doktype. That is why you can also disable the snippet preview based on PageTs. Below is an example of how to how the snippet preview if the page is a subpage of page with id 4.

[4 in tree.rootLineParentIds]
    mod.web_SeoPlugin {
        disableSnippetPreview = 1
    }
[global]

Basic auth configuration

For environments which are protected by Basic auth, it's possible to set username and password through $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['yoast_seo']['previewSettings']['basicAuth']

$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['yoast_seo']['previewSettings']['basicAuth'] = [
    'username' => 'authUsername',
    'password' => 'authPassword'
];

BreadcrumbList

The output for the type BreadcrumbList is provided by the provider key breadcrumb.

An example output for this provider is:

[
   {
      "@context":"https://www.schema.org",
      "@type":"BreadcrumbList",
      "itemListElement": [
         {
            "@type": "ListItem",
            "position": 1,
            "item": {
               "@id": "https://example.com/",
               "name": "Example"
            }
         },
         {
            "@type": "ListItem",
            "position": 2,
            "item": {
               "@id": "https://example.com/test-page",
               "name": "Test page"
            }
         }
      ]
   }
]

Possible configuration options:

WebSite

The output for the type WebSite is provided by the provider key site.

An example output for this provider is:

[
    {
        "@context": "https://www.schema.org",
        "@type": "WebSite",
        "url": "https://example.com/",
        "name": "Example"
    }
]

This provider does not have any configurable options.

Disabling provider(s)

If you want to disable a certain provider, you can do this by unsetting the provider key through typoscript. Example:

config.structuredData.providers.breadcrumb >

Custom provider

It is possible to register a custom provider. For this, it's necessary to create a class which implements the StructuredDataProviderInterface and provides a method getData which returns a multidimensional array. An example:

<?php
namespace Vendor\Package\StructuredData;

class CustomStructuredDataProvider implements \YoastSeoForTypo3\YoastSeo\StructuredData\StructuredDataProviderInterface
{
    public function getData(): array
    {
        return [
            [
                '@context' => 'https://schema.org',
                '@type' => 'Person',
                'name' => 'John Doe',
                'email' => 'john@doe.com'
            ]
        ];
    }
}

After you have created the class, you can add it to the provider-list by registering it through typoscript:

config.structuredData.providers {
    custom {
        provider = Vendor\Package\StructuredData\CustomStructuredDataProvider
    }
}

If you want to have custom configuration with your provider, you can add a method setConfiguration which will be automatically called if available.

Example:

protected $configuration = [];

public function setConfiguration(array $configuration): void
{
    $this->configuration = $configuration;
}

Structured data provider ordering

If you want to order the rendering of the providers, you can make use of the before and after settings.

If, for example, you want your custom provider to be rendered before breadcrumb and after site:

config.structuredData.providers {
    custom {
        provider = Vendor\Package\StructuredData\CustomStructuredDataProvider
        before = breadcrumb
        after = site
    }
}

Typoscript provider

It is possible to configure structured data through typoscript.

This is done through the config.structuredData.data object. The type and context keys do not need a @ and stdWrap is available on all keys.

An example for this configuration:

config.structuredData.data {
    10 {
        context = https://schema.org
        type = Person
        name = TEXT
        name.data = field:author
        email = TEXT
        email.data = field:author_email
    }
}

Required: adding PageTsconfig preview configuration

One important thing to know is that the snippet preview of records other than pages, only works when you have set a proper preview link. This is needed for both of the solutions above. The only thing you need to do is set some PageTsconfig. More information about the configuration of the preview links can be found in the documentation.

An example configuration of the preview links for EXT:news records is:

TCEMAIN.preview {
    tx_news_domain_model_news {
        previewPageId = <YOUR_DETAIL_PAGE_ID_HERE>
        useCacheHash = 1
        useDefaultLanguageRecord = 0
        fieldToParameterMap {
                uid = tx_news_pi1[news_preview]
        }
        additionalGetParameters {
                tx_news_pi1.controller = News
                tx_news_pi1.action = detail
        }
    }
}

What does the automatic functionality do?

By using the automatic functionality the following will be added to your records:

• Backend:

  • Fields of the core SEO extension:

    • SEO title
    • Robots: Index this page, Follow this page
    • Opengraph fields: Title, Description, Image
    • Twitter fields: Title, Description, Image, Card
    • Canonical link
    • Sitemap: Change frequency, Priority

  • Functionality of Yoast SEO:

    • Snippet preview
    • Title and Description progress bar
    • Readability Analysis
    • SEO Analysis
    • Focus keyword
    • Advanced robots: Image index, Archive, Snippet

• Frontend:

  • Metatag tags:

    • Description
    • Opengraph
    • Twitter
    • Robots

  • Canonical generation
  • Page title based on SEO Title and Title field

Configuration for a record

To get all the functionality mentioned above you only have to set the table name and the GET parameters on which it responds to. This should be placed in a file within Configuration/TCA/Overrides of your extension (f.e. sitepackage):

<?php

\YoastSeoForTypo3\YoastSeo\Utility\RecordUtility::configureForRecord('tx_extension_record')
     ->setGetParameters([
         ['tx_extension_pi1', 'record']
     ]);

This will automatically set the TCA, Database fields and activate the frontend functionality.

Configuration options

The method configureRecord returns an object which has the following methods:

->setGetParameters([
   ['tx_extension_pi1', 'record'],
   ['tx_extension_pi1', 'record_preview']
])

->setOverrideTca([
   'columns' => [
      'seo_title' => [
         'config' => [
            'max' => 100
         ]
      ]
   ]
])

Example with EXT:news

EXT:news has his own sitemap fields and has multiple GET parameters to respond to. The basic configuration can be:

\YoastSeoForTypo3\YoastSeo\Utility\RecordUtility::configureForRecord('tx_news_domain_model_news')
     ->setGetParameters([
         ['tx_news_pi1', 'news'],
         ['tx_news_pi1', 'news_preview']
     ])
     ->setSitemapFields(false)
     ->setFieldsPosition('after:bodytext');

Adding PageTsconfig

Make sure to add the needed PageTsconfig mentioned in Other Plugins

How to integrate in other plugins

By default the SEO analysis is only done on pages. If you want more type of records to use the SEO functions from Yoast SEO you have to add some fields to the TCA.

$llPrefix = 'LLL:EXT:yoast_seo/Resources/Private/Language/BackendModule.xlf:';
\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTCAcolumns(
    'tx_news_domain_model_news',
    [
        'tx_yoastseo_snippetpreview' => [
            'label' => $llPrefix . 'snippetPreview',
            'exclude' => true,
            'displayCond' => 'REC:NEW:false',
            'config' => [
                'type' => 'none',
                'renderType' => 'snippetPreview',
                'settings' => [
                    'titleField' => 'alternative_title',
                    'descriptionField' => 'description'
                ]
            ]
        ],
        'tx_yoastseo_readability_analysis' => [
            'label' => $llPrefix . 'analysis',
            'exclude' => true,
            'config' => [
                'type' => 'none',
                'renderType' => 'readabilityAnalysis'
            ]
        ],
        'tx_yoastseo_focuskeyword' => [
            'label' => $llPrefix . 'seoFocusKeyword',
            'exclude' => true,
            'config' => [
                'type' => 'input',
            ]
        ],
        'tx_yoastseo_focuskeyword_analysis' => [
            'label' => $llPrefix . 'analysis',
            'exclude' => true,
            'config' => [
                'type' => 'none',
                'renderType' => 'focusKeywordAnalysis',
                'settings' => [
                    'focusKeywordField' => 'tx_yoastseo_focuskeyword',
                ]
            ]
        ],

    ]
);

In the example above, you see we define four fields for in this case the EXT:news records.

The first field with renderType snippetPreview, is the field for the snippet preview. In the settings section, you have to define which fields contains the SEO title and the description. The snippet preview will use these fields to show you your search result will look like. Make sure the fields that are set, do exist. This field doesn't need a column in the database.

The second field doesn't need much configuration. Just add a field with renderType readabilityAnalysis to have the readabilityAnalysis in your record. This field also doesn't need a column in the database.

To have your content checked for SEO, you have to set a focus keyword, so we need to add that field as well. This can be a simple text field. This is the only field that needs a column in the database. Make sure you add this field to the database table for your records. For the news table this would be the following within the ext_tables.sql of your extension:

CREATE TABLE tx_news_domain_model_news (
    tx_yoastseo_focuskeyword varchar(100) DEFAULT '' NOT NULL,
);

To show the focus keyword analysis, we need to add a field of renderType focusKeywordAnalysis. In the settings section you have to define the field you have created with the focus keyword. This field also doesn't need a column in the database.

Adding PageTsconfig

Make sure to add the needed PageTsconfig mentioned in Other Plugins

Event to change the URL to analyse

By default the extension is generating the URL to analyse based on the Site Configuration and configured Route Enhancers. In some cases you want to change the URL that needs to be analysed. With the ModifyPreviewUrlEvent, you will be able to alter the URL that will be used to analyse your content.

First you need to create an EventListener that will :

<?php

namespace Vendor\Package\EventListener;

use YoastSeoForTypo3\YoastSeo\Event\ModifyPreviewUrlEvent;

final class ModifyPreviewUrlEventListener
{
    public function __invoke(ModifyPreviewUrlEvent $event)
    {
        $url = $event->getUrl();
        $site = $event->getSite();
        $pageId = $event->getPageId();
        $languageId = $event->getLanguageId();

        // Create a new url based on your needs

        $event->setUrl($newUrl);
    }
}

After you created your event listener to alter the URL, you need to register it in your Services.yaml.

Check the TYPO3 documentation for your used TYPO3 version on how to register this correctly.

After you have registered the listener, you need to clear the TYPO3 cache through the Maintenance module (or vendor/bin/typo3 cache:flush) before your code will be activated.

Where can I find the snippet preview?

The snippet preview is located in 2 places.

By default it is rendered within the page module above your content: |img-snippetpreview-page|

You can also find the snippet preview within the SEO tab of the page properties: |img-snippetpreview-properties|

What information is used for the snippet preview?

Can I disable the snippet preview?

There are two ways to disable the snippet preview within the page module:

|img-snippetpreview-hide-page|

|img-snippetpreview-hide-global|

Where can I find the analysis?

Insights

An example of a prominent words list:

|img-insights|

Focus keyphrase

Within this field you set the main focus of the page, for example "bike".

The value of this field will be taken into account with the content analysis, to make sure your content matches what you want to focus on.

Synonyms

Related keyphrases

|img-focus-related|

Cornerstone content

This shows a list of all the pages marked as "Cornerstone content" within your installation.

Pages without meta description

Orphaned content

Local environment with DDEV

In this repository we added a DDEV setup so you can easily test your contributions in all the TYPO3 versions the extension should work with.

First of all, make sure you have installed DDEV and Docker. See the DDEV documentation how to do that. After you have installed DDEV, run the following command in the root of this repository.

ddev start

After the setup is started, you can use the following command to make sure all installations are up and running.

ddev install-all

When the script is finished, you can go to https://yoast-seo.ddev.site and check the TYPO3 installations that are available to test your work.

ddev rm -O -R

rm -rf .Build/v11 .Build/v12 .Build/v13