SaferSettingField

La classe SaferSettingField représente un champ de paramètre dans le plugin Safer. Elle fournit des méthodes pour gérer l'affichage et l'enregistrement du champ.

Propriétés

  • private string|null $name : Nom du champ de paramètre.
  • private string|null $title : Titre du champ de paramètre.
  • private string|null $description : Description du champ de paramètre.
  • private mixed $content_callback : Fonction de rappel pour générer le contenu du champ de paramètre.
  • private string|null $title_label_for : Étiquette pour le titre du champ de paramètre.
  • private string|null $classname : Nom de la classe CSS pour le champ de paramètre.
  • private array|null $extra_args : Arguments supplémentaires pour le champ de paramètre.
  • private array|null $callback_args : Arguments à passer à la fonction de rappel.
  • private SaferSettingSection|null $section : Section à laquelle appartient le champ de paramètre.
  • private SaferSettingGroup|null $group : Groupe auquel appartient le champ de paramètre.

Constructeur

public function __construct(string $name, SaferSettingSection|SaferSettingGroup|null $parent = null)

Construit une nouvelle instance de SaferSettingField.

  • Paramètres :
    • string $name : Le nom du champ de paramètre.
    • SaferSettingSection|SaferSettingGroup|null $parent : La section ou le groupe parent auquel appartient ce champ de paramètre.

Méthodes

setTitle

public function setTitle(string $title): self

Définit le titre du champ de paramètre.

  • Paramètres :

    • string $title : Le titre du champ de paramètre.
  • Retour : self

setDescription

public function setDescription(string $description): self

Définit la description du champ de paramètre.

  • Paramètres :

    • string $description : La description du champ de paramètre.
  • Retour : self

setContentCallback

public function setContentCallback(callable $callback): self

Définit la fonction de rappel pour générer le contenu du champ de paramètre.

  • Paramètres :

    • callable $callback : La fonction de rappel à exécuter.
  • Retour : self

setContentCallbackFromFile

public function setContentCallbackFromFile(string $path, mixed ...$args)

Définit la fonction de rappel pour générer le contenu du champ de paramètre à partir d'un fichier.

  • Paramètres :

    • string $path : Le chemin vers le fichier contenant la fonction de rappel.
    • mixed ...$args : Les arguments à passer à la fonction de rappel.
  • Exceptions :

    • Lance une exception si le fichier n'existe pas.
    • Lance une exception si le fichier ne retourne pas une fonction callable.

setTitleLabelFor

public function setTitleLabelFor(string $title_label_for): self

Définit l'étiquette du titre pour un élément spécifique.

  • Paramètres :

    • string $title_label_for : L'étiquette du titre pour l'élément.
  • Retour : self

setClassname

public function setClassname(string $classname): self

Définit le nom de la classe CSS pour le champ de paramètre.

  • Paramètres :

    • string $classname : Le nom de la classe à définir.
  • Retour : self

setExtraArgs

public function setExtraArgs(array ...$args)

Définit des arguments supplémentaires pour le champ de paramètre.

  • Paramètres :
    • array ...$args : Les arguments supplémentaires à définir.

serializeToRegister

public function serializeToRegister(): array

Sérialise les paramètres à enregistrer dans WordPress.

  • Exceptions :

    • Lance une exception si le nom du champ de paramètre n'est pas défini.
    • Lance une exception si le titre du champ de paramètre n'est pas défini.
    • Lance une exception si la fonction de rappel pour le contenu n'est pas définie ou n'est pas callable.
  • Retour : array

wordpressRegister

public function wordpressRegister()

Enregistre une page et une section de paramètres WordPress.

getName

public function getName(): string|null

Récupère le nom du champ de paramètre.

  • Retour : string|null

getFullName

public function getFullName(): string

Récupère le nom complet du champ de paramètre.

  • Retour : string

getValue

public function getValue(mixed $default = null): mixed

Récupère la valeur du champ de paramètre.

  • Paramètres :

    • mixed $default : La valeur par défaut à retourner si le champ de paramètre n'est pas défini.
  • Retour : mixed