PHP Standards

PHP coding standards and security practices for the Oh My Brand! WordPress FSE theme.

When to Use

• Writing new PHP functions, classes, or methods
• Creating block render templates (render.php)
• Building helper functions (helpers.php)
• Working with WordPress hooks and filters
• Handling user input or output

Reference Files

File Header

Every PHP file must include:

<?php
/**
 * Short description of the file.
 *
 * @package theme-oh-my-brand
 */

declare(strict_types=1);

See file-structure.php for complete structure.

Naming Conventions

Function Prefix

Use omb_ prefix for theme functions:

// ✅ Good - prefixed
function omb_register_blocks(): void { }

// ❌ Bad - no prefix
function register_blocks(): void { }

Type Declarations

Use type hints for all function parameters and return types:

function format_gallery_images(array $images, int $limit = 10): array {
    // Implementation
}

Common Type Patterns

Output Escaping

All output must be escaped based on context:

See escaping-examples.php for examples.

Input Sanitization

Sanitize all input data before use:

See sanitization-examples.php for examples.

Nonce Verification

Use nonces for form submissions and AJAX:

See nonce-examples.php for examples.

WordPress Hooks

Common Actions

add_action('init', 'omb_register_blocks');
add_action('wp_enqueue_scripts', 'omb_enqueue_assets');
add_action('after_setup_theme', 'omb_setup_theme');

Hook Priority

add_action('init', 'omb_early_init', 5);    // Earlier
add_action('init', 'omb_normal_init');       // Default: 10
add_action('init', 'omb_late_init', 20);     // Later

See hooks-examples.php for examples.

Error Handling

Use early returns and guard clauses:

function omb_get_gallery_html(int $gallery_id): string {
    if ($gallery_id <= 0) {
        return '';
    }

    $gallery = get_post($gallery_id);

    if (!$gallery instanceof WP_Post) {
        return '';
    }

    return omb_render_gallery($gallery);
}

Related Skills

• html-standards - Semantic HTML and accessibility
• css-standards - BEM naming and styling
• phpunit-testing - PHP unit testing
• native-block-development - Block render templates

References

• WordPress PHP Coding Standards
• WordPress Data Validation
• WordPress Nonces