EDD_HTML_Elements

La classe EDD_HTML_Elements fournit une série de méthodes d'assistance pour le rendu des champs HTML couramment utilisés avec un balisage, des noms de classe et des attributs cohérents.

La classe comprend des méthodes pour les types de champs suivants :

product_dropdown()

Cette méthode crée un élément html select avec des produits. Les valeurs sont les product_ids et le texte est le titre du téléchargement.

Exemple :

echo EDD()->html->product_dropdown();

Cela créerait une liste déroulante de produits.  La méthode prend une entrée, un tableau, et a ces valeurs par défaut :

$defaults = array(
	'name'        => 'products',
	'id'          => 'products',
	'class'       => '', 
	'multiple'    => false,
	'selected'    => 0,
	'chosen'      => false,
	'number'      => 30, 
	'bundles'     => true,
	'placeholder' => sprintf( __( 'Select a %s', 'easy-digital-downloads' ), edd_get_label_singular() )
);

Voici une description de ce que contient chaque option :

nom

Ce serait la propriété "name" html de l'élément du formulaire.  Par défaut, 'products'.

Exemple :

id

	This would be the html “id” property of the html element.  Defaults to ‘products’.

	Example:

class

Ce serait la propriété "class" de l'élément html.  Par défaut, rien.

Exemple :

multiple

	This makes the select menu be of the “multiple” type. Defaults to false.

	Example:
	
selected

	This allows you to provide the product_id of a Download and have that one be pre-selected when the form loads.  Defaults to 0.
chosen

	This activated the “chosen” jquery plugin on your select box.  Defaults to false.

	Examples both closed and open:

	

	Below is chosen with ‘multiple’ set to true:
number

	This allows you to set a limit to the number of products in your list.  Defaults to 30.
bundles

	This allows you to decide if bundles should be included in your product list.  Defaults to true.
placeholder

	This is the text that goes in the first line of the select list, usually something like a title. The default is

	sprintf( __( ‘Select a %s’, ‘easy-digital-downloads’ ), edd_get_label_singular() )

	The above string has some plain English that says “Select a ” and then looks for a string with %s.  That string is provided by the function edd_get_label_singular().  edd_get_label_singular() gets the name of your product type in singular form.  edd_get_label_singular() defaults to “Download”.
customer_dropdown()

	This method creates a
	select html element with products in it.  Values are customer_ids and the text is Firstname Lastname .

	Example:
echo EDD()->html->customer_dropdown();


	This would create a drop down list of customers.  The method takes one input, an array, and has these defaults:
$defaults = array(
    'name'        => 'customers',
    'id'          => 'customers',
    'class'       => '',  
    'multiple'    => false,
    'selected'    => 0,   
    'chosen'      => true,
    'placeholder' => __( 'Select a Customer', 'easy-digital-downloads' ),
    'number'      => 30
);


	Here’s a description of what’s in each option:
name

	This would be the html “name” property of the form element.  Defaults to ‘customers’.

	Example:

id

Ce serait la propriété "id" html de l'élément html.  Par défaut, 'customers'.

Exemple :

class

	This would be the “class” property of the html element.  Defaults to nothing.

	Example:

multiple

Cela rend le menu de sélection de type "multiple". Par défaut, false.

Example:

selected

Cela vous permet de fournir un customer_id et de le présélectionner lorsque le formulaire se charge.  Par défaut, 0.

chosen

Cela active le plugin jquery "chosen" sur votre boîte de sélection.  Par défaut, false.

Examples both closed and open:

number

Cela vous permet de définir une limite au nombre de clients dans votre liste.  Par défaut, 30.

placeholder

C'est le texte qui apparaît sur la première ligne de la liste de sélection, généralement quelque chose comme un titre. Par défaut, "Select a Customer".

discount_dropdown()

Cette méthode crée un élément html select avec une liste de réductions. Les valeurs sont les discount_ids et le texte est le titre de la réduction.

Exemple :

echo EDD()->html->discount_dropdown();

Cela créerait une liste déroulante de réductions.

Entrée

Cette méthode prend trois valeurs en entrée.

nom

C'est le nom de l'élément html.  Par défaut, 'edd_discounts'

selected

C'est l'élément qui doit être sélectionné lorsque la boîte de sélection se charge.  Par défaut, rien n'est sélectionné, et l'élément par défaut sera la première réduction de la liste.

status

Les réductions peuvent être actives ou inactives. L’option « statut » permet de choisir l’une ou l’autre. Par défaut, rien n’est déclaré et toutes les réductions sont chargées.

category_dropdown()

Cette méthode crée un élément html select avec une liste de catégories de téléchargement. Les valeurs sont les term_ids et le texte est le titre de la catégorie.

Exemple :

echo EDD()->html->category_dropdown();

Cela créerait une liste déroulante de catégories de téléchargement.

Entrée

Cette méthode prend deux valeurs en entrée.

nom

Ceci est le nom de l’élément html. Par défaut, c’est ‘edd_categories’

selected

Ceci est l’élément qui doit être sélectionné au chargement de la boîte de sélection. Par défaut, rien n’est sélectionné et la boîte de sélection aura une option intitulée « Toutes les catégories ».

year_dropdown()

Cette méthode crée un élément html select avec une liste d’années. Le texte et la valeur de l’option sont tous deux une année à 4 chiffres.

Exemple :

echo EDD()->html->year_dropdown();

Cela créerait une liste déroulante de 6 années, l’année en cours étant sélectionnée par défaut.

Entrée

Cette méthode prend deux valeurs en entrée.

nom

Ceci est le nom de l’élément html. Par défaut, c’est ‘year’

selected

Ceci est l’élément qui doit être sélectionné au chargement de la boîte de sélection. Nécessite un entier à quatre chiffres.

month_dropdown()

Cette méthode crée un élément html select avec une liste de mois. Les valeurs sont des entiers non rembourrés et le texte est des abréviations de trois lettres des mois.

Exemple :

echo EDD()->html->year_dropdown();

Cela créerait une liste déroulante de 12 mois, le mois en cours étant sélectionné par défaut.

Entrée

Cette méthode prend deux valeurs en entrée.

nom

Ceci est le nom de l’élément html. Par défaut, c’est ‘month’

selected

Ceci est l’élément qui doit être sélectionné au chargement de la boîte de sélection. Nécessite un entier à deux chiffres.

select()

Cette méthode crée un élément html select et vous permet de le remplir avec n’importe quel tableau unidimensionnel.

Exemple :

echo EDD()->html->select( $args );

La méthode prend une entrée, un tableau, et a ces valeurs par défaut :

$args = array(
    'options'          => array(),
    'name'             => null,
    'class'            => '',
    'id'               => '',
    'selected'         => 0,
    'chosen'           => false,
    'placeholder'      => null,
    'multiple'         => false,
    'show_option_all'  => _x( 'All', 'all dropdown items', 'easy-digital-downloads' ),
    'show_option_none' => _x( 'None', 'no dropdown items', 'easy-digital-downloads' ),
);

Voici une description de ce que contient chaque option :

options

Ceci est un tableau unidimensionnel de choses comme ceci :

$args['options'] = array(
    '1' => 'Thing 1',
    '2' => 'Thing 2',
    '3' => 'Thing 3',
    '4' => 'Thing 4',
);

Les clés du tableau sont utilisées comme valeurs d’option de sélection, et les valeurs du tableau sont utilisées comme texte d’option de sélection.

nom

Ce serait la propriété « name » html de l’élément de formulaire. Par défaut, null, requis pour créer un élément de formulaire utile.

id

Ce serait la propriété « id » html de l’élément html. Par défaut, vide.

class

Ce serait la propriété « class » de l’élément html. Par défaut, vide.

multiple

Cela rend le menu de sélection de type "multiple". Par défaut, false.

Example:

selected

Cela vous permet de fournir une clé de votre tableau et de faire en sorte que celle-ci soit pré-sélectionnée au chargement du formulaire. Par défaut, 0.

chosen

Cela active le plugin jquery "chosen" sur votre boîte de sélection.  Par défaut, false.

Exemples fermés et ouverts :

placeholder

Ceci est le texte qui apparaît sur la première ligne de la liste de sélection, généralement quelque chose comme un titre. Par défaut, null.

show_option_all

Ceci crée une option de sélection avec une valeur de « all », et est insérée dans la liste des arguments de cette façon :

'show_option_all'  => _x( 'All', 'all dropdown items', 'easy-digital-downloads' ),

show_option_none

Ceci crée une option de sélection avec une valeur de « -1 », et est insérée dans la liste des arguments de cette façon :

'show_option_all'  => _x( 'None', 'no dropdown items', 'easy-digital-downloads' ),

checkbox()

Cette méthode crée un seul
checkbox élément html.

Note: This function does not create any wrapping HTML like .

Exemple :

html->checkbox( $args ); ?> Pick me!

La méthode prend une entrée, un tableau, et a ces valeurs par défaut :

$args = array(
    'name'     => null,
    'current'  => null,
    'class'    => 'edd-checkbox',
    'options'  => array(
        'disabled' => false,
        'readonly' => false
    )   
);

Voici une description de ce que contient chaque option :

nom

Ce serait la propriété « name » html de l’élément de formulaire. Par défaut, null, requis pour créer un élément de formulaire utile.

Note : le nom est également utilisé pour l'‘id’.

current

Ceci est la valeur préexistante du champ. Elle est utilisée pour déterminer si la case à cocher doit être cochée par défaut.

class

Ceci est la valeur de l'élément html ‘class’. Par défaut, ‘edd-checkbox’.

options

Ceci doit être un tableau, et peut contenir deux options.

• disabled – Définit le champ comme désactivé ou non avec true ou false.
• readonly – Définit le champ comme lecture seule ou non avec true ou false.

text()

Cette méthode crée un élément html de texte brut .

Exemple :

html->text( $args ); ?>

La méthode prend une entrée, un tableau, et a ces valeurs par défaut :

$args = array(
    'id'           => '',  
    'name'         => 'text', 
    'value'        => NULL, 
    'label'        => NULL, 
    'desc'         => NULL, 
    'placeholder'  => '',  
    'class'        => 'regular-text',
    'disabled'     => false,
    'autocomplete' => '',
    'data'         => false
);

Voici une description de ce que contient chaque option :

id

Ce serait la propriété html « id » de l'élément html.  Par défaut, vide.

nom

Ce serait la propriété html « name » de l'élément du formulaire.  Par défaut, « text ».

value

Ceci est la valeur préexistante du champ. Elle est utilisée pour pré-remplir le champ de texte avec cette valeur. Par défaut, NULL.

label

This is the text wrapped in a tag.  The tag a également une classe « edd-label » et un élément « for » qui utilise l'id mentionné ci-dessus. Par défaut, NULL.

desc

Ceci est du texte qui est enveloppé dans un span avec une classe « edd-description ».  Il est placé entre le label et l'input.  Par défaut, NULL.

placeholder

This text is placed in the “placeholder” element of the .  Rendering depends on the browser.  
You can read more about the placeholder element at w3schools.  Default is empty.

class

Ceci est la valeur de l'élément html ‘class’. Par défaut, ‘regular-text’.

disabled

Ceci définit le champ comme désactivé ou non.  Booléen, par défaut false.

autocomplete

Ceci définit l'élément autocomplete sur « on » ou « off ».  Par défaut, vide, ce qui équivaut à on dans la plupart des navigateurs modernes.

data

Ceci accepte un tableau, et crée des éléments html data à partir du tableau. Exemple :

array(
	'price' => '42.00',
	'variable-price' => 'no',
);

Le tableau ci-dessus résulterait en cet html placé à l'intérieur de l'input :

data-price="42.00" data-variable-price="no"

Défaut à false.

textarea()

Ceci crée une zone de texte HTML standard multiligne.

Exemple :

html->textarea( $args ); ?>

La méthode prend une entrée, un tableau, et a ces valeurs par défaut :

$args = array(
    'name'        => 'textarea',
    'value'       => null,
    'label'       => null,
    'desc'        => null,
    'class'       => 'large-text',
    'disabled'    => false
);

Voici une description de ce que contient chaque option.

nom

Ce serait la propriété "name" HTML de l'élément du formulaire.  Défaut à "textarea".

value

C'est la valeur préexistante du champ. Elle est utilisée pour pré-remplir le champ de texte avec cette valeur. Défaut à NULL.

label

This is the text wrapped in a tag.  The tag a également une classe « edd-label » et un élément « for » qui utilise l'id mentionné ci-dessus. Par défaut, NULL.

desc

Ceci est du texte encapsulé dans un span avec la classe "edd-description".  Il est placé après la balise textarea.  Défaut à NULL.

class

C'est la valeur de l'élément HTML 'class'. Défaut à 'large-text'.

disabled

Ceci définit le champ comme désactivé ou non.  Booléen, par défaut false.

ajax_user_search()

Cette méthode crée un champ de texte pour rechercher des utilisateurs EDD.  Elle utilise ajax pour rechercher pendant que vous tapez, et vous permet de cliquer pour choisir un résultat afin de remplir le champ.

Note : ce champ ne fonctionne que sur les pages d'administration EDD.  Pas sur le front-end de WordPress, ni dans d'autres zones d'administration WordPress.

Exemple :

html->ajax_user_search( $args ); ?>

La méthode prend une entrée, un tableau, et a ces valeurs par défaut :

$args = array(
    'name'        => 'user_id',
    'value'       => NULL,
    'placeholder' => __( 'Enter username', 'easy-digital-downloads' ),
    'label'       => NULL,
    'class'       => '',  
    'disabled'    => false,
    'autocomplete'=> 'off',
);

Voici une description de ce que contient chaque option.

nom

Ce serait la propriété "name" HTML de l'élément du formulaire.  Défaut à "user_id".

value

C'est la valeur préexistante du champ. Elle est utilisée pour pré-remplir le champ de texte avec cette valeur. Défaut à NULL.

placeholder

Ce texte est rendu dans la boîte de saisie dans la plupart des navigateurs. Défaut à :

__( 'Enter username', 'easy-digital-downloads' )

label

Ce texte n'apparaît pas sur le front-end du site, mais est utilisé avec aria pour les lecteurs d'écran. Défaut à NULL.

class

C'est la valeur de l'élément HTML 'class'. Défaut à vide.

disabled

Ceci définit le champ comme désactivé ou non.  Booléen, par défaut false.

autocomplete

Ceci définit l'élément autocomplete sur « on » ou « off ».  Par défaut, vide, ce qui équivaut à on dans la plupart des navigateurs modernes.