Developer Documentation - AIOSEO https://aioseo.com The Best WordPress SEO Plugin and Toolkit Wed, 08 Oct 2025 21:13:47 +0000 en-US hourly 1 https://aioseo.com/wp-content/uploads/2020/11/symbol-logo-lg-1.png Developer Documentation - AIOSEO https://aioseo.com 32 32 aioseo_report_summary_enable https://aioseo.com/docs/aioseo_report_summary_enable/?utm_source=rss&utm_medium=rss&utm_campaign=aioseo_report_summary_enable Mon, 30 Dec 2024 20:31:46 +0000 https://aioseo.com/?post_type=documentation&p=467305 Purpose This filter allows you to programmatically disable the delivery of SEO Email Reports by All in One SEO. Version Added This filter is available in All in One SEO 4.7.7 and above. Usage You can add the following filter…

The post aioseo_report_summary_enable first appeared on AIOSEO.]]>
Purpose

This filter allows you to programmatically disable the delivery of SEO Email Reports by All in One SEO.

Version Added

This filter is available in All in One SEO 4.7.7 and above.

Usage

You can add the following filter to disable the delivery of SEO Email reports:

Implementation

Need help using our code snippets? Checkout our documentation on “How do I use your API code examples?“.

We recommend using the WPCode plugin for safe and secure implementation. WPCode performs multiple sanitization tests before activating the snippets, ensuring the safety of your website.

The post aioseo_report_summary_enable first appeared on AIOSEO.]]>
aioseo_toc_hash_prefix https://aioseo.com/docs/aioseo_toc_hash_prefix/?utm_source=rss&utm_medium=rss&utm_campaign=aioseo_toc_hash_prefix Mon, 30 Dec 2024 20:28:53 +0000 https://aioseo.com/?post_type=documentation&p=467297 Purpose This filter allows you to customize or remove the prefix used in the anchor IDs and links generated by the Table of Contents (TOC) feature in All in One SEO. By default, All in One SEO adds a prefix…

The post aioseo_toc_hash_prefix first appeared on AIOSEO.]]>
Purpose

This filter allows you to customize or remove the prefix used in the anchor IDs and links generated by the Table of Contents (TOC) feature in All in One SEO.

By default, All in One SEO adds a prefix of “aioseo-” to the anchors in our Table of Contents Block.

Version Added

This filter is available in All in One SEO 4.7.1 and above.

Arguments

1. $prefix (string): New prefix. By default, this is set to “aioseo-“. You can modify it to another value or an empty string.

Example Code Snippet

The code snippet below is just an example of how this filter can be used. In the example below, a different prefix “mysite-” is used in the IDs instead of the default “aioseo-“.

In the code snippet below, the prefix is completely removed by passing an empty string.

Implementation

Need help using our code snippets? Checkout our documentation on “How do I use your API code examples?“.

We recommend using the WPCode plugin for safe and secure implementation. WPCode performs multiple sanitization tests before activating the snippets, ensuring the safety of your website.

The post aioseo_toc_hash_prefix first appeared on AIOSEO.]]>
aioseo_woocommerce_breadcrumb_hide_shop https://aioseo.com/docs/aioseo_woocommerce_breadcrumb_hide_shop/?utm_source=rss&utm_medium=rss&utm_campaign=aioseo_woocommerce_breadcrumb_hide_shop Tue, 19 Nov 2024 01:20:08 +0000 https://aioseo.com/?post_type=documentation&p=440645 Purpose This filter can be used to hide the WooCommerce Shop page from the breadcrumbs. Arguments (1) Example code snippet

The post aioseo_woocommerce_breadcrumb_hide_shop first appeared on AIOSEO.]]>
Purpose

This filter can be used to hide the WooCommerce Shop page from the breadcrumbs.

Arguments (1)

  1. $hide (boolean) – Whether to hide the shop page crumb.

Example code snippet

Implementation

Need help using our code snippets? Checkout our documentation on “How do I use your API code examples?“.

We recommend using the WPCode plugin for safe and secure implementation. WPCode performs multiple sanitization tests before activating the snippets, ensuring the safety of your website.

The post aioseo_woocommerce_breadcrumb_hide_shop first appeared on AIOSEO.]]>
Installing All in One SEO via Composer https://aioseo.com/docs/installing-all-in-one-seo-via-composer/?utm_source=rss&utm_medium=rss&utm_campaign=installing-all-in-one-seo-via-composer Tue, 20 May 2025 17:44:37 +0000 https://aioseo.com/?post_type=documentation&p=601282 You can install All in One SEO and All in One SEO Pro using Composer. This can help developers who want to automate the process of installing our plugins. In This Article Prerequisites Installing AIOSEO Lite Start by adding the…

The post Installing All in One SEO via Composer first appeared on AIOSEO.]]>
You can install All in One SEO and All in One SEO Pro using Composer. This can help developers who want to automate the process of installing our plugins.

Prerequisites

  • Composer installed on your system.
  • WordPress installation that uses composer.
  • For Pro version only: An active AIOSEO license key.

Installing AIOSEO Lite

Start by adding the AIOSEO repository to your composer file:

composer config repositories.aioseo composer https://licensing.aioseo.com/packages/

The Lite version is available without authentication. Simply run the following:

composer require "aioseo/lite:*"

Installing AIOSEO Pro

Start by adding the AIOSEO repository to your composer file:

composer config repositories.aioseo composer https://licensing.aioseo.com/packages/

The Pro version and any additional addons require authentication with your license key:

composer config -g http-basic.licensing.aioseo.com key [YOUR_LICENSE_KEY]

Run the following to nstall AIOSEO Pro:

composer require "aioseo/pro:*"

Or install specific addons (if your license includes them):

composer require "aioseo/redirects:*"
composer require "aioseo/link-assistant:*"
composer require "aioseo/eeat:*"
composer require "aioseo/image-seo:*"
composer require "aioseo/index-now:*"
composer require "aioseo/video-sitemap:*"
composer require "aioseo/news-sitemap:*"
composer require "aioseo/local-business:*"
composer require "aioseo/rest-api:*"

Customizing the Installation Path (Optional)

By default, packages will be installed to wp-content/plugins/. If you need a custom path, just add the following to your composer.json:

"extra": {
    "installer-paths": {
        "wp-content/plugins/{$name}/": ["type:wordpress-plugin"]
    }
}

Replace wp-content/plugins/ with your preferred directory path.

Updating Plugins

To update to the latest version:

composer update aioseo/pro

To update to a specific version:

composer require "aioseo/pro:4.3.0"

Troubleshooting

Authentication Errors

  • Verify your license key is active and correctly entered
  • Ensure your license key has access to the requested package

Package Not Found

  • For Pro packages: Check that your license key is authorized for the requested package
  • Verify the package name is spelled correctly (aioseo/pro or aioseo/lite)

Installation Path Issues

  • Check that the WordPress plugin directory exists and is writable

Further Assistance

If you need further assistance, please contact our Support team here.

The post Installing All in One SEO via Composer first appeared on AIOSEO.]]>
aioseo_import_rank_math_posts_per_action https://aioseo.com/docs/aioseo_import_rank_math_posts_per_action/?utm_source=rss&utm_medium=rss&utm_campaign=aioseo_import_rank_math_posts_per_action Tue, 21 May 2024 13:26:37 +0000 https://aioseo.com/?post_type=documentation&p=326850 Purpose This filter can be used to increase or decrease the default number of posts imported per batch ( defaults to 100 ). Arguments (1) Example code snippet

The post aioseo_import_rank_math_posts_per_action first appeared on AIOSEO.]]>
Purpose

This filter can be used to increase or decrease the default number of posts imported per batch ( defaults to 100 ).

Arguments (1)

  1. $number (int) – The number of posts to import per batch.

Example code snippet

Implementation

Need help using our code snippets? Checkout our documentation on “How do I use your API code examples?“.

We recommend using the WPCode plugin for safe and secure implementation. WPCode performs multiple sanitization tests before activating the snippets, ensuring the safety of your website.

The post aioseo_import_rank_math_posts_per_action first appeared on AIOSEO.]]>
aioseo_import_seopress_posts_per_action https://aioseo.com/docs/aioseo_import_seopress_posts_per_action/?utm_source=rss&utm_medium=rss&utm_campaign=aioseo_import_seopress_posts_per_action Tue, 21 May 2024 13:27:57 +0000 https://aioseo.com/?post_type=documentation&p=326856 Purpose This filter can be used to increase or decrease the default number of posts imported per batch ( defaults to 100 ). Arguments (1) Example code snippet

The post aioseo_import_seopress_posts_per_action first appeared on AIOSEO.]]>
Purpose

This filter can be used to increase or decrease the default number of posts imported per batch ( defaults to 100 ).

Arguments (1)

  1. $number (int) – The number of posts to import per batch.

Example code snippet

Implementation

Need help using our code snippets? Checkout our documentation on “How do I use your API code examples?“.

We recommend using the WPCode plugin for safe and secure implementation. WPCode performs multiple sanitization tests before activating the snippets, ensuring the safety of your website.

The post aioseo_import_seopress_posts_per_action first appeared on AIOSEO.]]>
aioseo_import_yoast_seo_posts_per_action https://aioseo.com/docs/aioseo_import_yoast_seo_posts_per_action/?utm_source=rss&utm_medium=rss&utm_campaign=aioseo_import_yoast_seo_posts_per_action Tue, 21 May 2024 13:28:29 +0000 https://aioseo.com/?post_type=documentation&p=326858 Purpose This filter can be used to increase or decrease the default number of posts imported per batch ( defaults to 100 ). Arguments (1) Example code snippet

The post aioseo_import_yoast_seo_posts_per_action first appeared on AIOSEO.]]>
Purpose

This filter can be used to increase or decrease the default number of posts imported per batch ( defaults to 100 ).

Arguments (1)

  1. $number (int) – The number of posts to import per batch.

Example code snippet

Implementation

Need help using our code snippets? Checkout our documentation on “How do I use your API code examples?“.

We recommend using the WPCode plugin for safe and secure implementation. WPCode performs multiple sanitization tests before activating the snippets, ensuring the safety of your website.

The post aioseo_import_yoast_seo_posts_per_action first appeared on AIOSEO.]]>
aioseo_redirects_log_skip https://aioseo.com/docs/aioseo_redirects_log_skip/?utm_source=rss&utm_medium=rss&utm_campaign=aioseo_redirects_log_skip Tue, 19 Mar 2024 13:08:36 +0000 https://aioseo.com/?post_type=documentation&p=298356 Purpose This filter can be used to skip logging redirect logging in AIOSEO Redirects. Arguments (2) Example code snippet This snippet will successfully prevent AIOSEO from logging 404 errors for the specified URLs

The post aioseo_redirects_log_skip first appeared on AIOSEO.]]>
Purpose

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

Arguments (2)

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

Example code snippet

This snippet will successfully prevent AIOSEO from logging 404 errors for the specified URLs

Implementation

Need help using our code snippets? Checkout our documentation on “How do I use your API code examples?“.

We recommend using the WPCode plugin for safe and secure implementation. WPCode performs multiple sanitization tests before activating the snippets, ensuring the safety of your website.

The post aioseo_redirects_log_skip first appeared on AIOSEO.]]>
aioseo_user_profile_tab_allowed_user_ids https://aioseo.com/docs/aioseo_user_profile_tab_allowed_user_ids/?utm_source=rss&utm_medium=rss&utm_campaign=aioseo_user_profile_tab_allowed_user_ids Tue, 21 May 2024 13:56:44 +0000 https://aioseo.com/?post_type=documentation&p=326862 Purpose This filter can be used to allow users that don't have editing permissions to edit their Author SEO meta data. Arguments (2) Example code snippet

The post aioseo_user_profile_tab_allowed_user_ids first appeared on AIOSEO.]]>
Purpose

This filter can be used to allow users that don't have editing permissions to edit their Author SEO meta data.

Arguments (2)

  1. $user_ids (array) – An array of user IDs.
  2. $user_id (int) – The current user ID.

Example code snippet

Implementation

Need help using our code snippets? Checkout our documentation on “How do I use your API code examples?“.

We recommend using the WPCode plugin for safe and secure implementation. WPCode performs multiple sanitization tests before activating the snippets, ensuring the safety of your website.

The post aioseo_user_profile_tab_allowed_user_ids first appeared on AIOSEO.]]>
aioseo_get_post_id https://aioseo.com/docs/aioseo_get_post_id/?utm_source=rss&utm_medium=rss&utm_campaign=aioseo_get_post_id Tue, 29 Aug 2023 14:42:47 +0000 https://aioseo.com/?post_type=documentation&p=222363 Purpose This filter can be used to change the Post ID being processed by AIOSEO. Arguments (1) Example code snippet

The post aioseo_get_post_id first appeared on AIOSEO.]]>
Purpose

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

Implementation

Need help using our code snippets? Checkout our documentation on “How do I use your API code examples?“.

We recommend using the WPCode plugin for safe and secure implementation. WPCode performs multiple sanitization tests before activating the snippets, ensuring the safety of your website.

The post aioseo_get_post_id first appeared on AIOSEO.]]>