EDD_HTML_Elements

Die Klasse EDD_HTML_Elements bietet eine Reihe von Hilfsmethoden zum Rendern gängiger HTML-Felder mit konsistentem Markup, Klassennamen und Attributen.

Die Klasse enthält Methoden für die folgenden Feldtypen:

product_dropdown()

Diese Methode erstellt ein
select HTML-Element mit Produkten darin. Die Werte sind product_ids und der Text sind die Download-Titel.

Beispiel:

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

Dies würde eine Dropdown-Liste von Produkten erstellen. Die Methode nimmt eine Eingabe, ein Array, und hat diese Standardwerte:

$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() )
);

Hier ist eine Beschreibung dessen, was in jeder Option enthalten ist:

name

Dies wäre die HTML-Eigenschaft „name“ des Formularelements. Standardmäßig „products“.

Beispiel:

id

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

	Example:

class

Dies wäre die Eigenschaft „class“ des HTML-Elements. Standardmäßig nichts.

Beispiel:

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

Dies wäre die HTML-Eigenschaft „id“ des HTML-Elements. Standardmäßig „customers“.

Beispiel:

class

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

	Example:

multiple

Dies macht das Select-Menü vom Typ „multiple“. Standardmäßig false.

Example:

selected

Dies ermöglicht es Ihnen, eine customer_id anzugeben und diese beim Laden des Formulars vorauszuwählen. Standardmäßig 0.

chosen

Dies aktiviert das „chosen“-jQuery-Plugin für Ihre Select-Box. Standardmäßig false.

Examples both closed and open:

number

Dies ermöglicht es Ihnen, die Anzahl der Kunden in Ihrer Liste zu begrenzen. Standardmäßig 30.

placeholder

Dies sind die Texte, die in der ersten Zeile der Select-Liste stehen, normalerweise etwas wie ein Titel. Der Standard ist „Select a Customer“.

discount_dropdown()

Diese Methode erstellt ein
select HTML-Element mit einer Liste von Rabatten darin. Die Werte sind discount_ids und der Text ist der Titel des Rabatts.

Beispiel:

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

Dies würde eine Dropdown-Liste von Rabatten erstellen.

Eingabe

Diese Methode nimmt drei Werte als Eingabe.

name

Dies ist der Name des HTML-Elements. Der Standard ist „edd_discounts“

selected

Dies ist der Eintrag, der ausgewählt werden soll, wenn die Select-Box geladen wird. Standardmäßig ist nichts ausgewählt, und der Standardeintrag ist der erste Rabatt in der Liste.

status

Rabatte können aktiv oder inaktiv sein.  Die Option „Status“ ermöglicht die Wahl zwischen beiden.  Standardmäßig wird nichts deklariert, und alle Rabatte werden geladen.

category_dropdown()

Diese Methode erstellt ein
select HTML-Element mit einer Liste von Download-Kategorien darin. Die Werte sind Term-IDs und der Text ist der Titel der Kategorie.

Beispiel:

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

Dies würde eine Dropdown-Liste von Download-Kategorien erstellen.

Eingabe

Diese Methode nimmt zwei Werte als Eingabe.

name

Dies ist der Name des HTML-Elements.  Der Standard ist „edd_categories“

selected

Dies ist der Eintrag, der ausgewählt werden soll, wenn die Select-Box geladen wird. Standardmäßig ist nichts ausgewählt, und die Select-Box hat eine Option mit dem Titel „Alle Kategorien“.

year_dropdown()

Diese Methode erstellt ein
select HTML-Element mit einer Liste von Jahren darin. Text und Optionswert sind beide eine 4-stellige Jahreszahl.

Beispiel:

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

Dies würde eine Dropdown-Liste von 6 Jahren erstellen, wobei das aktuelle Jahr standardmäßig ausgewählt ist.

Eingabe

Diese Methode nimmt zwei Werte als Eingabe.

name

Dies ist der Name des HTML-Elements.  Der Standard ist „year“

selected

Dies ist der Eintrag, der ausgewählt werden soll, wenn die Select-Box geladen wird.  Erfordert eine vierstellige Ganzzahl.

month_dropdown()

Diese Methode erstellt ein
select HTML-Element mit einer Liste von Monaten darin. Die Werte sind ungepolsterte Ganzzahlen und der Text sind dreibuchstabige Abkürzungen von Monaten.

Beispiel:

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

Dies würde eine Dropdown-Liste von 12 Monaten erstellen, wobei der aktuelle Monat standardmäßig ausgewählt ist.

Eingabe

Diese Methode nimmt zwei Werte als Eingabe.

name

Dies ist der Name des HTML-Elements.  Der Standard ist „month“

selected

Dies ist der Eintrag, der ausgewählt werden soll, wenn die Select-Box geladen wird. Erfordert eine zweistellige Ganzzahl.

select()

Diese Methode erstellt ein
select HTML-Element und ermöglicht es Ihnen, es mit jedem eindimensionalen Array zu füllen.

Beispiel:

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

Die Methode nimmt eine Eingabe, ein Array, und hat diese Standardwerte:

$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' ),
);

Hier ist eine Beschreibung dessen, was in jeder Option enthalten ist:

options

Dies ist ein eindimensionales Array von Dingen wie diesem:

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

Die Array-Schlüssel werden als Select-Optionswerte verwendet, und die Array-Werte werden als Select-Optionstext verwendet.

name

Dies wäre die HTML-Eigenschaft „name“ des Formularelements.  Standardmäßig null, erforderlich, um ein nützliches Formularelement zu erstellen.

id

Dies wäre die HTML-Eigenschaft „id“ des HTML-Elements.  Standardmäßig leer.

class

Dies wäre die „class“-Eigenschaft des HTML-Elements.  Standardmäßig leer.

multiple

Dies macht das Select-Menü vom Typ „multiple“. Standardmäßig false.

Example:

selected

Dies ermöglicht es Ihnen, einen Schlüssel aus Ihrem Array anzugeben, und dieser wird beim Laden des Formulars vorausgewählt.  Standardmäßig 0.

chosen

Dies aktiviert das „chosen“-jQuery-Plugin für Ihre Select-Box. Standardmäßig false.

Beispiele, sowohl geschlossen als auch offen:

placeholder

Dies ist der Text, der in der ersten Zeile der Select-Liste steht, normalerweise etwas wie ein Titel. Der Standard ist null.

show_option_all

Dies erstellt eine Select-Option mit dem Wert „all“ und wird auf diese Weise in die Argumentenliste eingefügt:

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

show_option_none

Dies erstellt eine Select-Option mit dem Wert „-1“ und wird auf diese Weise in die Argumentenliste eingefügt:

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

checkbox()

Diese Methode erstellt ein einzelnes
Kontrollkästchen HTML-Element.

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

Beispiel:

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

Die Methode nimmt eine Eingabe, ein Array, und hat diese Standardwerte:

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

Hier ist eine Beschreibung dessen, was in jeder Option enthalten ist:

name

Dies wäre die HTML-Eigenschaft „name“ des Formularelements.  Standardmäßig null, erforderlich, um ein nützliches Formularelement zu erstellen.

Hinweis: Der Name wird auch für die „id“ verwendet.

current

Dies ist der vorhandene Wert des Feldes. Er wird verwendet, um zu bestimmen, ob das Kontrollkästchen standardmäßig aktiviert sein soll.

class

Dies ist der Wert des HTML-Elements „class“. Standardmäßig „edd-checkbox“.

options

Dies muss ein Array sein und kann zwei Optionen enthalten.

• disabled – Setzt das Feld auf deaktiviert oder nicht mit true oder false.
• readonly – Setzt das Feld auf schreibgeschützt oder nicht mit true oder false.

text()

Diese Methode erstellt ein einfaches Text-HTML-Element.

Beispiel:

html->text( $args ); ?>

Die Methode nimmt eine Eingabe, ein Array, und hat diese Standardwerte:

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

Hier ist eine Beschreibung dessen, was in jeder Option enthalten ist:

id

Dies wäre die HTML-Eigenschaft „id“ des HTML-Elements. Standardmäßig leer.

name

Dies wäre die HTML-Eigenschaft „name“ des Formularelements. Standardmäßig „text“.

value

Dies ist der vorhandene Wert des Feldes. Er wird verwendet, um das Textfeld mit diesem Wert vorab zu füllen. Standardmäßig NULL.

label

This is the text wrapped in a tag.  The Tag hat auch eine Klasse „edd-label“ und ein „for“-Element, das die oben genannte ID verwendet. Standardmäßig NULL.

desc

Dies ist Text, der in einem Span mit der Klasse „edd-description“ eingeschlossen ist. Er wird zwischen dem Label und der Eingabe platziert. Standardmäßig 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

Dies ist der Wert des HTML-Elements „class“. Standardmäßig „regular-text“.

disabled

Dies setzt das Feld auf deaktiviert oder nicht. Boolean, Standard ist false.

autocomplete

Dies setzt das Autocomplete-Element auf „on“ oder „off“. Standard ist leer, was in den meisten modernen Browsern „on“ entspricht.

data

Dies akzeptiert ein Array und erstellt aus dem Array Daten-HTML-Elemente. Beispiel:

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

Das obige Array würde dazu führen, dass dieser HTML-Code in die Eingabe eingefügt wird:

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

Standardmäßig auf false gesetzt.

textarea()

Dies erstellt ein standardmäßiges mehrzeiliges HTML-Textfeld.

Beispiel:

html->textarea( $args ); ?>

Die Methode nimmt eine Eingabe, ein Array, und hat diese Standardwerte:

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

Hier ist eine Beschreibung dessen, was in jeder Option enthalten ist.

name

Dies wäre die HTML-„name“-Eigenschaft des Formularelements.  Standardmäßig „textarea“.

value

Dies ist der bereits vorhandene Wert des Feldes. Er wird verwendet, um das Textfeld mit diesem Wert vorab zu füllen. Standardmäßig NULL.

label

This is the text wrapped in a tag.  The Tag hat auch eine Klasse „edd-label“ und ein „for“-Element, das die oben genannte ID verwendet. Standardmäßig NULL.

desc

Dies ist Text, der in einem Span mit der Klasse „edd-description“ eingeschlossen ist.  Er wird nach dem Textarea-Tag platziert.  Standardmäßig NULL.

class

Dies ist der Wert des HTML-Elements „class“. Standardmäßig „large-text“.

disabled

Dies setzt das Feld auf deaktiviert oder nicht. Boolean, Standard ist false.

ajax_user_search()

Diese Methode erstellt ein Textfeld zur Suche nach EDD-Benutzern.  Sie verwendet Ajax, um zu suchen, während Sie tippen, und ermöglicht es Ihnen, auf ein Ergebnis zu klicken, um das Feld zu füllen.

Hinweis: Dieses Feld funktioniert nur auf EDD-Adminseiten.  Nicht auf der WordPress-Vorderseite und nicht in anderen WordPress-Adminbereichen.

Beispiel:

html->ajax_user_search( $args ); ?>

Die Methode nimmt eine Eingabe, ein Array, und hat diese Standardwerte:

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

Hier ist eine Beschreibung dessen, was in jeder Option enthalten ist.

name

Dies wäre die HTML-„name“-Eigenschaft des Formularelements.  Standardmäßig „user_id“.

value

Dies ist der bereits vorhandene Wert des Feldes. Er wird verwendet, um das Textfeld mit diesem Wert vorab zu füllen. Standardmäßig NULL.

placeholder

Dieser Text wird in den meisten Browsern im Eingabefeld angezeigt. Standardmäßig:

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

label

Dieser Text erscheint nicht auf der Vorderseite der Website, wird aber mit Aria für Screenreader verwendet. Standardmäßig NULL.

class

Dies ist der Wert des HTML-Elements „class“. Standardmäßig leer.

disabled

Dies setzt das Feld auf deaktiviert oder nicht. Boolean, Standard ist false.

autocomplete

Dies setzt das Autocomplete-Element auf „on“ oder „off“. Standard ist leer, was in den meisten modernen Browsern „on“ entspricht.