Add Filter

Add Filter Hook

Add a new filter hook to the Saman SEO plugin with proper documentation.

Arguments

• $ARGUMENTS should contain: filter name (e.g., "title_separator") and description

Steps

1. Analyze where the filter should be added:

   • Identify the file and function where the value is computed
   • Determine what data should be filterable
   • Consider what additional context to pass

2. Add the filter using apply_filters():

/**
 * Filter the {description}.
 *
 * @since {version}
 *
 * @param {type} ${variable} The {description}.
 * @param {additional_params} Additional context parameters.
 */
$variable = apply_filters( 'SAMAN_SEO_{filter_name}', $variable, $additional_context );

3. Document the filter in FILTERS.md:

### `SAMAN_SEO_{filter_name}`

{Description of what this filter does.}

**Parameters:**
- `${variable}` ({type}) - The {description}.
- `$context` (array) - Additional context.

**Example:**
```php
add_filter( 'SAMAN_SEO_{filter_name}', function( $value, $context ) {
    // Modify $value
    return $value;
}, 10, 2 );

Since: {version}

## Naming Conventions

- **Prefix**: Always use `SAMAN_SEO_` prefix
- **Style**: Use snake_case for filter names
- **Clarity**: Name should describe what's being filtered

## Common Filter Patterns

### Value Filter
```php
$title = apply_filters( 'SAMAN_SEO_meta_title', $title, $post_id );

Array Filter

$schema = apply_filters( 'SAMAN_SEO_schema_data', $schema, $post, $context );

Boolean Filter

$enabled = apply_filters( 'SAMAN_SEO_feature_enabled', $enabled, $feature_name );

Output Filter

$html = apply_filters( 'SAMAN_SEO_breadcrumb_html', $html, $breadcrumbs );

Existing Filter Categories

Reference existing filters in FILTERS.md:

1. Title Filters: SAMAN_SEO_title, SAMAN_SEO_title_separator
2. Meta Filters: SAMAN_SEO_meta_description, SAMAN_SEO_canonical_url
3. Schema Filters: SAMAN_SEO_schema_*, SAMAN_SEO_jsonld_output
4. Sitemap Filters: SAMAN_SEO_sitemap_*
5. Feature Toggles: SAMAN_SEO_feature_toggle
6. Admin Filters: SAMAN_SEO_admin_*

Best Practices

1. Pass sufficient context - Include related objects (post, term, etc.)
2. Document the return type - Be explicit about expected return values
3. Use appropriate hook priority - Default is 10, lower = earlier
4. Consider backwards compatibility - Don't break existing filter signatures
5. Add version since tag - Track when the filter was introduced

Example Usage

/add-filter og_image_size Customize the Open Graph image dimensions

This will:

1. Find where OG images are processed
2. Add the filter with proper docblock
3. Update FILTERS.md with documentation

Converted and distributed by TomeVault — claim your Tome and manage your conversions.