This filter can be used to skip logging redirect logging in AIOSEO Redirects.

Arguments (1)

1. $skip (boolean) – Skip logging.
2. $data (array) – The redirect data.

Example code snippet

add_filter( 'aioseo_redirects_log_skip', 'redirects_log_skip', 10, 2 );
function redirects_log_skip( $skip, $data ) {
	if ( 404 === $data['http_code'] ) {
		$skip = true;
	}

	return $skip;
}

This filter can be used to change the Post ID being processed by AIOSEO.

Arguments (1)

1. $postId (integer) – The Post ID.

Example code snippet

add_filter( 'aioseo_get_post_id', 'aioseo_change_post_id' );
function aioseo_change_post_id( $postId ) {
	if( is_post_type_archive( 'product' ) ) {
		$postId = 123;
	}

	return $postId;
}

This filter can be used to publicly hide the All in One SEO version number.

Arguments (1)

1. $hide (boolean) – Whether to hide the version number in the frontend.

Example code snippet

add_filter( 'aioseo_hide_version_number', '__return_true' );

This can be particularly useful when you for instance have:

• A headless WordPress site where you need to manually output your SEO data on the frontend;
• A 3rd party system to manage your posts (e.g. eCommerce ERP with WooCommerce integration) and would like to be able to manage your SEO data via that system.

Below we’ll explain which data is available via the REST API and how you can update it.

Fetching Data

Instead of registering custom endpoints, the REST API addon integrates with the default endpoints from WordPress Core. Currently, all GET post and term routes are supported.

These include:

• /wp/v2/posts
• /wp/v2/pages
• /wp/v2/media
• /wp/v2/categories
• /wp/v2/tags

And also all routes for custom post types and custom taxonomies on your website that have support for the REST API enabled.

The following fields will be included in the response of these routes:

aioseo_head

This field includes the raw SEO data that would normally be output by All in One SEO into the source code of your post/term as a text string.

If you have a headless WordPress website, you can output this data straight into the source code on the frontend of your installation.

aioseo_head_json

This field includes the same values of the aioseo_head data (see above), but in JSON format.

This allows you to easily filter the data before you output it into the source code or use it for another purpose.

Please note that this data does not include the HTML code for the meta tags that these values are used for, so you’ll need to construct these yourself.

aioseo_meta_data

This field includes the data that is stored into AIOSEO’s custom post and term tables in JSON format.

This data should be mainly used when you want to manipulate the existing data and then update it on your website.

Updating Data

In order to update data via the REST API, you must authenticate yourself. If you are unsure how to do this, please read the WordPress REST API documentation.

The user you’ve authenticated with must also have any of the following capabilities in order to be able to update any AIOSEO data via the REST API:

• aioseo_page_general_settings
• aioseo_page_social_settings
• aioseo_page_schema_settings
• aioseo_page_advanced_settings

Once you’ve met these requirements, you can update data via a POST/PUT request by adding the property aioseo_meta_data in the body of the request.

Inside this property, you can specify any of the keys that are included in the aioseo_meta_data field (see above), along with the new value.

Below is an example of how this looks like:

{
	"aioseo_meta_data": {
		"title":"NEW TITLE",
		"description":"NEW DESCRIPTION"
	}
}

If you have any particular questions about the REST API, please feel free to reach out to our support team. We will be more than happy to help you.

Common uses for these filter hooks are:

• Localizing the post/term meta AIOSEO outputs in the source code
• Integrating with the multilingual sitemap capabilities of AIOSEO
• Localizing the options of AIOSEO (e.g. default title/description formats)

Localizing Post/Term Meta

One of the core functionalities of All in One SEO is outputting SEO data, social markup and JSON schema into the source code of every page.

AIOSEO stores this data in its own custom tables, aioseo_posts and aioseo_terms. As a result, this data cannot be accessed like traditional post/term meta.

Filtering Data When it is Loaded

When this data is loaded, it can be filtered using the aioseo_get_post and aioseo_get_term hooks.

The data is typically only loaded once per request and should stay consistent for the duration of the request.

Filtering Data When it is Saved

If needed, the data can also be filtered before it is saved by using the aioseo_save_post and aioseo_save_term hooks.

Please note the following:

• If a post is saved via the Block Editor, then this hook will run twice. Once when the post is saved via the REST API by the Block Editor; another time when the post is saved via a regular POST request.
• AIOSEO should automatically sanitize any of the data you’ve filtered, but we still implore you to adequately sanitize any data you manipulate on your end as well.

Integrating with the multilingual sitemap

All in One SEO is capable of generating a multilingual sitemap if you tell it what the translated versions of each post/term are. You can add dynamically add this information using our aioseo_sitemap_post and aioseo_sitemap_term hooks respectively.

Supported Plugins

The following multilingual plugins have been confirmed as compatible with AIOSEO:

• WPML

These plugins may support AIOSEO, but have not been confirmed yet:

• TranslatePress
• Polylang
• Weglot
• MultilingualPress
• qTranslate-XT
• WPGlobus

Don’t see a plugin on this list or does your multilingual plugin not support AIOSEO yet? Then please reach out to the developer of the plugin and ask them to add support. You can refer them to this page for technical information on our filter hooks.

Are you a developer and do you need help to integrate your plugin with All in One SEO? Send us a message via our Basic Question form and we will be in touch with you shortly.

if ( function_exists( 'aioseo' ) ) {
	aioseo()->head->output();
}

if desired, you can control which sections of data are output using the aioseo_meta_views filter hook.

add_filter( 'aioseo_schema_output', 'aioseo_filter_schema_output' );

function aioseo_filter_schema_output( $schema ) {
	foreach ( $schema as $index => $graphData ) {
		if ( empty( $graphData['@type'] ) ) {
			continue;
		}

		$type = strtolower( $graphData['@type'] );
		switch ( $type ) {
			case 'article':
			case 'blogposting':
			case 'newsarticle':
				unset( $schema[ $index ]['datePublished'] );
				unset( $schema[ $index ]['dateModified'] );
				break;
			default:
				break;
		}
	}

	return $schema;
}

This filter can be used to manage the excluded roles from Access Control.

Arguments (1)

1. $roles (array) – A list of roles being ignored.

Example code snippet

The code snippet below is just an example of how this filter can be used. In the example below, we’ll remove the customer role from the excluded roles.

// Removes the customer role from the exclusion list.
add_filter( 'aioseo_access_control_excluded_roles', 'aioseo_filter_access_control_excluded_roles' );
function aioseo_filter_access_control_excluded_roles( $roles ) {
	if ( ( $key = array_search( 'customer', $roles ) ) !== false ) {
		unset( $roles[ $key ] );
	}
	return $roles;
}

Changelog

This filter can be used to add or remove the link from the current item in the breadcrumb trail.

Arguments (1)

1. $linkCurrentItem (boolean) – Keep or remove the link.

Example code snippet

The code snippet below is just an example of how this filter can be used. In the example below we’ll remove the link from the current breadcrumb item if we’re on a page.

// Removes the link of the last crumb if it's a page.
add_filter( 'aioseo_breadcrumbs_link_current_item', 'aioseo_breadcrumbs_link_current_item', 10 );
function aioseo_breadcrumbs_link_current_item( $linkCurrentItem ) {
	if ( is_singular( 'page' ) ) {
		$linkCurrentItem = false;
	}

	return $linkCurrentItem;
}

This filter can be used to control the display of breadcrumbs (show or hide).

Arguments (1)

1. $display (boolean) – Show or hide.

Example code snippet

The code snippet below is just an example of how this filter can be used. In the example below we’ll hide the breadcrumbs on pages.

// Hide breadcrumbs on pages.
add_filter( 'aioseo_breadcrumbs_output', 'aioseo_breadcrumbs_output' );
function aioseo_breadcrumbs_output( $display ) {
	if ( is_singular( 'page' ) ) {
		$display = false;
	}

	return $display;
}