PHPackages                             defox/module-seosuite - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. defox/module-seosuite

ActiveMagento2-module[Utility & Helpers](/categories/utility)

defox/module-seosuite
=====================

A comprehensive SEO Lite solution for Magento 2.4.7

1.0.3(11mo ago)191GPL-3.0-or-laterPHPPHP ~8.2.0

Since Jul 1Pushed 11mo ago1 watchersCompare

[ Source](https://github.com/MLisiecki/defox-seosuite-lite)[ Packagist](https://packagist.org/packages/defox/module-seosuite)[ RSS](/packages/defox-module-seosuite/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (6)Versions (5)Used By (0)

Defox SEO Suite Lite
====================

[](#defox-seo-suite-lite)

[![License: GPLv3](https://camo.githubusercontent.com/5aaa0440fae67581e0967960628ae76c788bc4db458829e259a23cf572a342d4/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d47504c76332d79656c6c6f772e737667)](https://opensource.org/licenses/MIT)[![Magento 2.4.7](https://camo.githubusercontent.com/d119cf5f0c6a5052535754b36bc06650e3e36801b9d7f9741509f0fffea4e92d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d6167656e746f2d322e342e372d6f72616e67652e737667)](https://devdocs.magento.com/)[![PHP 8.2+](https://camo.githubusercontent.com/0f16581d1180dbfd4c0e13166ec1267d4ad2f2fab8281ea6d6b284cf5c65d921/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e322532422d626c75652e737667)](https://www.php.net/)

A comprehensive SEO Lite solution for Magento 2.4.7 that provides advanced meta tag templates, canonical URLs, structured data, XML sitemaps, and SEO-friendly URLs with an intuitive admin interface.

Table of Contents
-----------------

[](#table-of-contents)

- [Features](#features)
- [About This Edition](#about-this-edition)
- [Requirements](#requirements)
- [Installation](#installation)
- [Configuration](#configuration)
- [Features Overview](#features-overview)
- [Usage](#usage)
- [Development](#development)
- [Contributing](#contributing)
- [Troubleshooting](#troubleshooting)
- [Upgrading to Full Version](#upgrading-to-full-version)
- [License](#license)
- [Support](#support)

Features
--------

[](#features)

### 🏷️ **Meta Tag Templates**

[](#️-meta-tag-templates)

- Dynamic template system with variable support
- Templates for title, description, keywords, and robots meta tags
- Open Graph support (title, description, type, image)
- Entity-specific templates (products, categories, CMS pages)
- Template prioritization and conditional application
- Variable processor with extensive placeholder support

### 🔗 **Canonical URLs**

[](#-canonical-urls)

- Advanced canonical URL management
- Product canonical URLs with multiple strategies
- Category canonical URLs with pagination support
- Filter parameter handling
- Configurable exclusions for products and categories
- High-performance caching system

### 📊 **Structured Data (JSON-LD)**

[](#-structured-data-json-ld)

- Schema.org compliant structured data generation
- Support for Organization, WebSite, WebPage schemas
- Product schema with pricing, reviews, and availability
- Category, Article, and Review schemas
- Product attribute mapping to schema properties
- Built-in schema validation
- Performance-optimized caching

### 🗺️ **XML Sitemap**

[](#️-xml-sitemap)

- Enhanced XML sitemap generation
- Support for products, categories, and CMS pages
- Image inclusion in sitemap entries
- Hreflang support for multilingual sites
- Automatic search engine notifications
- Analytics and statistics dashboard
- XML validation and error reporting
- Automated CRON scheduling

### 🌐 **Friendly URLs**

[](#-friendly-urls)

- SEO-friendly URLs for category filters
- Customizable URL patterns and separators
- Attribute name mapping to friendly terms
- Multi-value parameter support
- URL rewriting and routing

### ⚡ **Cache Management**

[](#-cache-management)

- Dedicated cache types for different features
- Configurable cache backends
- Automatic cache invalidation
- Performance optimization
- Lifetime management

### 🎛️ **Admin Interface**

[](#️-admin-interface)

- Comprehensive admin panel
- Meta tag template management
- Sitemap dashboard with analytics
- Sitemap generator and validator
- Structured data preview
- Detailed configuration options

About This Edition
------------------

[](#about-this-edition)

Defox SEO Suite Lite is a streamlined version of our comprehensive SEO Suite platform, specifically curated to provide essential SEO functionality while maintaining the same high-quality codebase. This edition shares its foundation with the full enterprise version, which means:

- **Future-Ready Architecture**: The module is built with extensibility in mind, allowing seamless upgrades to the full version
- **Enterprise-Grade Code Quality**: All components follow the same strict coding standards and design patterns used in our commercial offering
- **Modular Design**: Some classes and interfaces may appear unused in this Lite edition but serve as foundation components for advanced features in the full version
- **Professional Foundation**: This approach ensures consistency, maintainability, and provides a clear upgrade path for growing businesses

While this Lite edition focuses on core SEO functionality, the underlying architecture supports advanced enterprise features like AI-powered content optimization, advanced analytics, multi-site management, and custom integrations available in the full version.

Requirements
------------

[](#requirements)

- **Magento**: 2.4.7+
- **PHP**: 8.2+
- **Dependencies**:
    - Magento\_Store
    - Magento\_Catalog
    - Magento\_Cms
    - Magento\_UrlRewrite
    - Magento\_Sitemap
    - Magento\_LayeredNavigation
    - Magento\_Swatches

Installation
------------

[](#installation)

### Via Composer (Recommended)

[](#via-composer-recommended)

```
composer require defox/module-seosuite
php bin/magento module:enable Defox_SEOSuite
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento cache:flush
```

### Manual Installation

[](#manual-installation)

1. Download the module files
2. Extract to `app/code/Defox/SEOSuite/`
3. Run the installation commands:

```
php bin/magento module:enable Defox_SEOSuite
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento cache:flush
```

Configuration
-------------

[](#configuration)

Navigate to **Stores → Configuration → Defox → SEO Suite** in your Magento admin panel. Do not forget to create a folder for sitemap.xml on Your host.

### Basic Setup

[](#basic-setup)

1. **General Settings**: Enable the module and configure debug mode
2. **Meta Tags**: Enable template system and configure override behavior
3. **Canonical URLs**: Enable canonical URL generation for different entity types
4. **Structured Data**: Enable JSON-LD generation and configure schema types
5. **XML Sitemap**: Configure sitemap generation settings and schedules

### Advanced Configuration

[](#advanced-configuration)

- **Organization Information**: Configure business details for structured data
- **Product Attribute Mapping**: Map product attributes to schema.org properties
- **Cache Settings**: Optimize performance with cache configuration
- **URL Patterns**: Customize friendly URL generation

Features Overview
-----------------

[](#features-overview)

### Meta Tag Templates

[](#meta-tag-templates)

Create dynamic meta tag templates using variables:

```
Product Title: {{product.name}} - {{category.name}} | {{store.name}}
Meta Description: {{product.name}} - {{product.short_description}} Starting at {{product.price}}

```

**Available Variables:**

- **Products**: `{{product.name}}`, `{{product.sku}}`, `{{product.price}}`, `{{category.name}}`, etc.
- **Categories**: `{{category.name}}`, `{{category.description}}`, `{{parent_category.name}}`, etc.
- **CMS Pages**: `{{cms_page.title}}`, `{{cms_page.content}}`, `{{cms_page.identifier}}`, etc.
- **Store**: `{{store.name}}`, `{{store.url}}`, etc.

### Structured Data Examples

[](#structured-data-examples)

The module automatically generates structured data for:

**Product Schema:**

```
{
  "@context": "https://schema.org",
  "@type": "Product",
  "name": "Product Name",
  "description": "Product Description",
  "brand": {
    "@type": "Brand",
    "name": "Brand Name"
  },
  "offers": {
    "@type": "Offer",
    "price": "99.99",
    "priceCurrency": "USD",
    "availability": "https://schema.org/InStock"
  }
}
```

**Organization Schema:**

```
{
  "@context": "https://schema.org",
  "@type": "Organization",
  "name": "Your Company",
  "url": "https://yoursite.com",
  "logo": "https://yoursite.com/logo.png",
  "address": {
    "@type": "PostalAddress",
    "streetAddress": "123 Main St",
    "addressLocality": "City",
    "addressRegion": "State",
    "postalCode": "12345"
  }
}
```

### XML Sitemap Features

[](#xml-sitemap-features)

- **Automatic Generation**: Scheduled via CRON
- **Multi-entity Support**: Products, categories, CMS pages
- **Image Sitemaps**: Include product images
- **Hreflang**: Multi-language support
- **Analytics**: Track sitemap performance
- **Validation**: Ensure XML compliance

Usage
-----

[](#usage)

### Managing Meta Tag Templates

[](#managing-meta-tag-templates)

1. Navigate to **SEO Suite → Meta Tag Templates**
2. Create new templates for different entity types
3. Use variables to create dynamic content
4. Set priorities and conditions for template application

### Generating Sitemaps

[](#generating-sitemaps)

1. Go to **SEO Suite Sitemap → Generation**
2. Configure sitemap settings
3. Generate manually or set up automatic generation
4. Monitor progress in the Analytics dashboard

### Previewing Structured Data

[](#previewing-structured-data)

1. Visit **SEO Suite → Structured Data Preview**
2. Enter entity IDs to preview generated schema
3. Validate schema.org compliance
4. Test different configuration settings

### Console Commands

[](#console-commands)

Generate sitemap via command line:

```
php bin/magento defox:sitemap:generate
```

Development
-----------

[](#development)

### File Structure

[](#file-structure)

```
Defox/SEOSuite/
├── Api/                    # API interfaces
├── Block/                  # Block classes
├── Console/                # Console commands
├── Controller/             # Controllers
├── Cron/                   # Cron jobs
├── Helper/                 # Helper classes
├── Model/                  # Models and business logic
├── Observer/               # Event observers
├── Plugin/                 # Plugins/interceptors
├── Setup/                  # Installation/upgrade scripts
├── Template/               # Template processors
├── Ui/                     # UI components
├── view/                   # Frontend/admin templates
├── etc/                    # Configuration files
└── i18n/                   # Translations

```

### Key Classes

[](#key-classes)

- **`Model/MetaTag/Manager`**: Core meta tag template processing
- **`Model/StructuredData/AbstractGenerator`**: Base for structured data generators
- **`Model/Sitemap/Generator/XmlGenerator`**: XML sitemap generation
- **`Helper/StructuredDataManager`**: Structured data management
- **`Template/VariableProcessorFactory`**: Variable processing system

### Extending the Module

[](#extending-the-module)

#### Adding Custom Variables

[](#adding-custom-variables)

```