Porter des Plugins WordPress

Sur cette page

De nombreux plugins WordPress peuvent être portés vers EmDash. Le modèle de plugin est différent—TypeScript au lieu de PHP, hooks au lieu d’actions/filtres, stockage structuré au lieu de wp_options—mais la plupart des fonctionnalités se mappent proprement.

Évaluation de la Portabilité

Tous les plugins n’ont pas de sens à porter. Évaluez les candidats avant de commencer.

Bons candidats

Champs personnalisés, plugins SEO, processeurs de contenu, extensions d’UI d’administration, analytics, partage social, formulaires

Mauvais candidats

Fonctionnalités multisite, intégrations WooCommerce/Gutenberg, plugins qui patchent les composants internes du cœur WordPress

Comparaison de Structure de Plugin

WordPress

wp-content/plugins/my-plugin/
├── my-plugin.php       # Fichier principal avec en-tête du plugin
├── includes/
│   ├── class-admin.php
│   └── class-api.php
└── admin/
    └── js/

EmDash

my-plugin/
├── src/
│   ├── index.ts    # Définition du plugin (definePlugin)
│   └── admin.tsx   # Exports d'UI d'administration (React)
├── package.json
└── tsconfig.json

Mappage des Hooks

WordPress utilise add_action() et add_filter() avec des noms de hooks en chaîne. EmDash utilise des hooks typés déclarés dans la définition du plugin.

Hooks de Cycle de Vie

WordPressEmDashNotes
register_activation_hook()plugin:installS’exécute une fois lors de la première installation
Plugin activéplugin:activateS’exécute lors de l’activation
Plugin désactivéplugin:deactivateS’exécute lors de la désactivation
register_uninstall_hook()plugin:uninstallevent.deleteData indique le choix de l’utilisateur

Hooks de Contenu

WordPressEmDashNotes
wp_insert_post_datacontent:beforeSaveRetourne le contenu modifié ou lance une erreur pour annuler
save_postcontent:afterSaveEffets secondaires après la sauvegarde
before_delete_postcontent:beforeDeleteRetourner false pour annuler
deleted_postcontent:afterDeleteNettoyage après la suppression

WordPress

add_action('save_post', function($post_id, $post, $update) {
    if ($post->post_type !== 'product') return;

    $price = get_post_meta($post_id, 'price', true);
    if ($price > 1000) {
        update_post_meta($post_id, 'is_premium', true);
    }

}, 10, 3);

EmDash

hooks: {
    "content:afterSave": async (event, ctx) => {
        if (event.collection !== "products") return;

        const price = event.content.price as number;
        if (price > 1000) {
            await ctx.kv.set(`premium:${event.content.id}`, true);
        }
    },
}

Hooks de Médias

WordPressEmDashNotes
wp_handle_upload_prefiltermedia:beforeUploadValider ou transformer
add_attachmentmedia:afterUploadRéagir après l’upload

Mappage du Stockage

Options API → KV Store

WordPress

$api_key = get_option('my_plugin_api_key', '');
update_option('my_plugin_api_key', 'abc123');
delete_option('my_plugin_api_key');

EmDash

const apiKey = await ctx.kv.get<string>("settings:apiKey") ?? "";
await ctx.kv.set("settings:apiKey", "abc123");
await ctx.kv.delete("settings:apiKey");

Tables Personnalisées → Collections de Stockage

WordPress

global $wpdb;
$table = $wpdb->prefix . 'my_plugin_items';

// Insérer
$wpdb->insert($table, ['name' => 'Item 1', 'status' => 'active']);

// Requête
$items = $wpdb->get_results(
"SELECT \* FROM $table WHERE status = 'active' LIMIT 10"
);

EmDash

// Déclarer dans la définition du plugin
storage: {
    items: {
        indexes: ["status", "createdAt"],
    },
},

// Dans les hooks ou routes:
await ctx.storage.items.put("item-1", {
    name: "Item 1",
    status: "active",
    createdAt: new Date().toISOString(),
});

const result = await ctx.storage.items.query({
    where: { status: "active" },
    limit: 10,
});

Schéma de Paramètres

WordPress utilise l’API Settings pour les formulaires d’administration. EmDash utilise un schéma déclaratif qui génère automatiquement l’UI.

WordPress

add_action('admin_init', function() {
    register_setting('my_plugin', 'my_plugin_api_key');
    add_settings_section('main', 'Settings', null, 'my-plugin');
    add_settings_field('api_key', 'API Key', function() {
        $value = get_option('my_plugin_api_key');
        echo '<input type="text" name="my_plugin_api_key"
              value="' . esc_attr($value) . '">';
    }, 'my-plugin', 'main');
});

EmDash

admin: {
    settingsSchema: {
        apiKey: {
            type: "secret",
            label: "Clé API",
            description: "Votre clé API depuis le tableau de bord",
        },
        enabled: {
            type: "boolean",
            label: "Activé",
            default: true,
        },
        limit: {
            type: "number",
            label: "Limite d'Items",
            default: 100,
            min: 1,
            max: 1000,
        },
    },
}

UI d’Administration

Les pages d’administration WordPress sont en PHP. EmDash utilise des composants React.

import { useState, useEffect } from "react";

export const widgets = {
	summary: function SummaryWidget() {
		const [count, setCount] = useState(0);

		useEffect(() => {
			fetch("/_emdash/api/plugins/my-plugin/status")
				.then((r) => r.json())
				.then((data) => setCount(data.count));
		}, []);

		return <div>Total d'items: {count}</div>;
	},
};

export const pages = {
	settings: function SettingsPage() {
		// Composant React pour la page de paramètres
		return <div>Contenu des paramètres</div>;
	},
};

Enregistrer dans la définition du plugin:

admin: {
    entry: "@my-org/my-plugin/admin",
    pages: [{ path: "/settings", label: "Tableau de bord" }],
    widgets: [{ id: "summary", title: "Résumé", size: "half" }],
},

REST API → Routes de Plugin

WordPress

register_rest_route('my-plugin/v1', '/items', [
    'methods' => 'GET',
    'callback' => function($request) {
        global $wpdb;
        $items = $wpdb->get_results("SELECT * FROM items LIMIT 50");
        return new WP_REST_Response($items);
    },
]);

EmDash

routes: {
    items: {
        handler: async (ctx) => {
            const result = await ctx.storage.items.query({ limit: 50 });
            return { items: result.items };
        },
    },
},

Les routes sont disponibles à /_emdash/api/plugins/{plugin-id}/{route-name}.

Processus de Portage

  1. Analyser le plugin WordPress

    Documentez ce qu’il fait: hooks, opérations de base de données, pages d’administration, endpoints REST.

  2. Mapper aux concepts EmDash

    Hooks WordPress → Hooks EmDash. wp_optionsctx.kv. Tables personnalisées → Collections de stockage. Pages d’administration → Composants React. Endpoints REST → Routes de plugin.

  3. Créer le squelette du plugin

    import { definePlugin } from "emdash";
    
    export function createPlugin() {
    	return definePlugin({
    		id: "my-ported-plugin",
    		version: "1.0.0",
    		capabilities: [],
    		storage: {},
    		hooks: {},
    		routes: {},
    		admin: {},
    	});
    }
  4. Implémenter dans l’ordre

    Stockage → Hooks → UI d’Administration → Routes

  5. Tester minutieusement

    Vérifiez que les hooks se déclenchent correctement, le stockage fonctionne et l’UI d’administration se rende.

Exemple: Plugin de Temps de Lecture

WordPress

add_filter('wp_insert_post_data', function($data, $postarr) {
    if ($data['post_type'] !== 'post') return $data;

    $content = strip_tags($data['post_content']);
    $word_count = str_word_count($content);
    $read_time = ceil($word_count / 200);

    if (!empty($postarr['ID'])) {
        update_post_meta($postarr['ID'], '_read_time', $read_time);
    }
    return $data;

}, 10, 2);

EmDash

export function createPlugin() {
    return definePlugin({
        id: "read-time",
        version: "1.0.0",

        admin: {
            settingsSchema: {
                wordsPerMinute: {
                    type: "number",
                    label: "Mots par minute",
                    default: 200,
                    min: 100,
                    max: 400,
                },
            },
        },

        hooks: {
            "content:beforeSave": async (event, ctx) => {
                if (event.collection !== "posts") return;

                const wpm = await ctx.kv.get<number>("settings:wordsPerMinute") ?? 200;
                const text = JSON.stringify(event.content.body || "");
                const readTime = Math.ceil(text.split(/\s+/).length / wpm);

                return { ...event.content, readTime };
            },
        },
    });
}

Capacités

Les plugins doivent déclarer les capacités requises pour le sandboxing de sécurité:

CapacitéFournitCas d’Usage
network:requestctx.http.fetch()Appels API externes
content:readctx.content.get(), list()Lecture de contenu CMS
content:writectx.content.create(), etc.Modification de contenu
media:readctx.media.get(), list()Lecture de médias
media:writectx.media.getUploadUrl()Upload de médias

Pièges Courants

Pas d’état global — Utilisez le stockage au lieu de variables globales.

Tout asynchrone — Utilisez toujours await pour les appels de stockage et d’API.

Pas de SQL direct — Utilisez des collections de stockage structurées.

Pas de système de fichiers — Utilisez l’API de médias pour les fichiers.

Prochaines Étapes