PhoenixKit.Modules.SEO (phoenix_kit v1.7.71)

Copy Markdown View Source

SEO module for PhoenixKit.

Provides project-wide search visibility controls. Currently supports a noindex, nofollow directive for staging environments, and will be extended with additional SEO options in the future.

Summary

Functions

Disables the SEO module and clears any active directives.

Disables the global noindex, nofollow directive.

Enables the SEO module (exposes the settings page).

Enables the global noindex, nofollow directive.

Returns configuration metadata for dashboard cards and settings pages.

Indicates whether the SEO module is available in the admin.

Returns true when the noindex, nofollow directive is active.

Updates the directive to the provided boolean value.

Functions

disable_module()

Disables the SEO module and clears any active directives.

disable_no_index()

Disables the global noindex, nofollow directive.

enable_module()

Enables the SEO module (exposes the settings page).

enable_no_index()

Enables the global noindex, nofollow directive.

get_config()

Returns configuration metadata for dashboard cards and settings pages.

module_enabled?()

Indicates whether the SEO module is available in the admin.

no_index_enabled?()

Returns true when the noindex, nofollow directive is active.

update_no_index(enabled?)

Updates the directive to the provided boolean value.