Ajouter un champ de personnalisé dans WP Form Master

Le code suivant crée un champ personnalisé de sélection de post pour le plugin WP Form Master, permettant aux utilisateurs de choisir un article dans une liste déroulante dans un formulaire. Ce champ vérifie également si une sélection valide a été faite (si obligatoire), enregistre l’ID ou le titre du post sélectionné, et permet de l’ajouter dans les formulaires grâce à un shortcode.

Code

PHP

<?php
if (!defined('ABSPATH'))
    exit;

class WP_FormMaster_AddCustomField_PostSelect {
    private $fieldname = "select-post";
    private $isRequired = true;

    public function __construct() {
        add_filter("allowed_block_types_all", array($this, "setBlocks"), 11, 2);
        add_shortcode("wpformmaster-form-post-select", [$this, "postSelectCallback"]);
        add_filter("wpfmaster_form_extractfields", array($this, "extractFields"), 10, 4);
        add_filter("wpformmaster_field_value", array($this, "getFieldValue"), 10, 7);
        add_filter("wpfmaster_form_validate_field", array($this, "addRequiredError"), 10, 8);
    }

    public function addRequiredError($error, $formID, $key, $type, $field, $errors, $posts, $files) {
        if (!$error) {
            if ($key && $key === $this->fieldname) {
                if ($this->isRequired) {
                    if (isset($posts[$key])) {
                        $post = get_post($posts[$key]);
                        if (!$post || $post->post_type != "post") {
                            $error = __("Veuillez sélectionner un article", "my-domain");
                        }
                    }
                }
            }
        }
        return $error;
    }

    public function getFieldValue($value, $key, $type, $attrs, $posts, $files, $getInterpretValue) {
        if ($key && $key === $this->fieldname) {
            if ($getInterpretValue) {
                if (isset($posts[$key]) && $posts[$key]) {
                    $post = get_post($posts[$key]);
                    if ($post) {
                        return sanitize_text_field($post->post_title);
                    }
                }
            } else {
                if (isset($posts[$key]) && $posts[$key]) {
                    return intval($posts[$key]);
                }
            }
        }
        return $value;
    }

    public function extractFields($fields, $formID, $posts, $files) {
        return array_merge($fields, [
            [
                "attrs" => [
                    "type" => "custom-select",
                    "name" => $this->fieldname
                ]
            ]
        ]);
    }

    public function postSelectCallback($atts) {
        ob_start();
        extract(
            shortcode_atts(
                array(
                    'title' => __("Article", "my-domain"),
                ),
                $atts
            )
        );
        ?>
        <div class="formmaster-field" datatype="select" dataname="<?= $this->fieldname; ?>">
            <div class="formmaster-select">
                <select name="<?= $this->fieldname; ?>">
                    <option value=""><?= $title . ($this->isRequired ? "*" : ""); ?></option>
                    <?php
                    $posts = get_posts([
                        'post_type' => array("post"),
                        'post_status' => 'publish',
                        'suppress_filters' => false,
                        'posts_per_page' => -1,
                        "orderby" => array(
                            "title" => "ASC"
                        )
                    ]);
                    foreach ($posts as $post) {
                        ?>
                        <option value="<?= $post->ID; ?>"><?= $post->post_title; ?></option>
                        <?php
                    }
                    ?>
                </select>
            </div>
        </div>
        <?php
        return ob_get_clean();
    }

    public function setBlocks($allowed_blocks, $editor_context) {
        if ($editor_context->post && $editor_context->post->post_type === "fmaster_form") {
            return array_merge($allowed_blocks, [
                'core/shortcode'
            ]);
        }
        return $allowed_blocks;
    }
}

new WP_FormMaster_AddCustomField_PostSelect();
?>

Explications

Structure globale de la classe

La classe WP_FormMaster_AddCustomField_PostSelect définit et enregistre un nouveau champ personnalisé qui affiche une liste déroulante de posts. Ce champ utilise plusieurs filtres et raccourcis WordPress pour s’intégrer au formulaire, contrôler l’affichage, et gérer la validation.

Variables de la classe

$fieldname : Stocke le nom du champ, ici "select-post".
$isRequired : Indique si le champ est requis, ici défini sur true.

Constructeur de la classe

Le constructeur de la classe ajoute plusieurs filtres et un shortcode pour intégrer le champ personnalisé dans le formulaire :

allowed_block_types_all : Utilisé pour définir quels blocs sont autorisés dans le formulaire WordPress.
wpformmaster-form-post-select : Crée un shortcode pour afficher la liste déroulante des posts dans le formulaire.
wpfmaster_form_extractfields : Permet d’ajouter les attributs du champ personnalisé au formulaire.
wpformmaster_field_value : Extrait et interprète la valeur sélectionnée dans le champ pour l’enregistrement des données.
wpfmaster_form_validate_field : Gère la validation du champ pour s’assurer qu’un post a bien été sélectionné si le champ est requis.

Méthodes de la classe

1. `addRequiredError`

Cette méthode est utilisée pour ajouter un message d’erreur si l’utilisateur ne sélectionne pas de post dans le champ obligatoire :

Paramètres : Elle reçoit plusieurs paramètres comme $formID, $key (nom du champ), $type, $field, $errors, $posts, et $files.
Fonctionnement :
- Elle vérifie d’abord si le champ est obligatoire.
- Ensuite, elle vérifie si un post valide est sélectionné (existant et de type post).
- Si le champ est vide ou contient une sélection non valide, elle renvoie un message d’erreur : "Veuillez sélectionner un article".

2. `getFieldValue`

Cette méthode détermine la valeur du champ à enregistrer dans le formulaire :

Paramètres : En plus de $value, $key, $type, $attrs, $posts, $files, elle prend aussi $getInterpretValue pour indiquer si la valeur doit être interprétée.
Fonctionnement :
- Si $getInterpretValue est true, elle renvoie le titre du post sélectionné.
- Sinon, elle renvoie simplement l’ID du post (en tant qu’entier).
- Si le champ est vide, elle renvoie la valeur par défaut de $value.

3. `extractFields`

Cette méthode permet d’ajouter ce champ au tableau des champs extraits par WP Form Master :

Fonctionnement :
- Elle ajoute un nouveau champ avec un attribut de type custom-select et le nom défini dans $fieldname.
- Ce champ sera ensuite disponible pour le formulaire, avec le nom approprié pour être identifié lors de l’envoi.

4. `postSelectCallback`

Cette méthode définit l’affichage HTML du champ de sélection dans le formulaire :

Paramètres : Elle prend $atts pour accepter les attributs personnalisés passés dans le shortcode.
Fonctionnement :
- Utilise get_posts pour récupérer tous les posts publiés.
- Crée une liste déroulante HTML où chaque option représente un post, affichant son titre et stockant son ID comme valeur.
- Si $isRequired est true, le titre du champ sera marqué d’un astérisque pour indiquer qu’il est obligatoire.

5. `setBlocks`

Cette méthode autorise certains blocs pour l’éditeur de blocs WordPress (Gutenberg) lorsque le formulaire est modifié :

Fonctionnement :
- Si l’éditeur est dans le contexte d’un formulaire WP Form Master (ici identifié par le post type fmaster_form), elle autorise le bloc core/shortcode.
- Cela permet d’utiliser le shortcode pour ajouter ce champ spécifique dans l’éditeur de blocs.

Instanciation de la classe

La ligne new WP_FormMaster_AddCustomField_PostSelect(); crée une nouvelle instance de la classe et active le champ personnalisé lorsque le code est exécuté.

Back-office

Wypo Wp Form Master Exemples Ajout Champ Personnalise

Ajout d’un champ personnalisé pour sélectionner un article de blog