EDD_HTML_Elements

A classe EDD_HTML_Elements fornece uma série de métodos auxiliares para renderizar campos HTML comumente usados com marcação, nomes de classe e atributos consistentes.

A classe inclui métodos para os seguintes tipos de campo:

product_dropdown()

Este método cria um elemento HTML select com produtos. Os valores são product_ids e o texto é Títulos de Download.

Exemplo:

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

Isso criaria uma lista suspensa de produtos.  O método recebe uma entrada, um array, e tem estes padrões:

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

Aqui está uma descrição do que está em cada opção:

name

Esta seria a propriedade "name" do HTML do elemento do formulário.  O padrão é 'products'.

Exemplo:

id

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

	Example:

class

Esta seria a propriedade "class" do elemento HTML.  O padrão é nenhum.

Exemplo:

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

Esta seria a propriedade "id" do HTML do elemento HTML.  O padrão é 'customers'.

Exemplo:

class

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

	Example:

multiple

Isso torna o menu select do tipo "multiple". O padrão é false.

Exemplo:

selected

Isso permite que você forneça um customer_id e que ele seja pré-selecionado quando o formulário for carregado.  O padrão é 0.

chosen

Isso ativa o plugin "chosen" do jquery na sua caixa de seleção.  O padrão é false.

Exemplos fechados e abertos:

numero

Isso permite que você defina um limite para o número de clientes na sua lista.  O padrão é 30.

placeholder

Este é o texto que vai na primeira linha da lista de seleção, geralmente algo como um título. O padrão é "Select a Customer".

discount_dropdown()

Este método cria um elemento HTML select com uma lista de Descontos. Os valores são discount_ids e o texto é o título do Desconto.

Exemplo:

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

Isso criaria uma lista suspensa de descontos.

Input

Este método recebe três valores como entrada.

name

Este é o nome do elemento HTML.  O padrão é 'edd_discounts'

selected

Este é o item que deve ser selecionado quando a caixa de seleção for carregada.  O padrão é não ter nada selecionado, e o item padrão será o primeiro desconto na lista.

status

Os descontos podem estar ativos ou inativos.  A opção 'status' permite escolher um ou outro.  O padrão é não declarar, e todos os Descontos são carregados.

category_dropdown()

Este método cria um elemento html
select com uma lista de categorias de Download. Os valores são term_ids e o texto é o título da categoria.

Exemplo:

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

Isso criaria uma lista suspensa de categorias de Download.

Input

Este método recebe dois valores como entrada.

name

Este é o nome do elemento html.  O padrão é 'edd_categories'

selected

Este é o item que deve ser selecionado quando a caixa de seleção for carregada. O padrão é não ter nada selecionado, e a caixa de seleção terá uma opção intitulada “Todas as Categorias”.

year_dropdown()

Este método cria um elemento html
select com uma lista de anos. O texto e o valor da opção são ambos um ano de 4 dígitos.

Exemplo:

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

Isso criaria uma lista suspensa de 6 anos, com o ano atual selecionado por padrão.

Input

Este método recebe dois valores como entrada.

name

Este é o nome do elemento html.  O padrão é 'year'

selected

Este é o item que deve ser selecionado quando a caixa de seleção for carregada.  Requer um inteiro de quatro dígitos.

month_dropdown()

Este método cria um elemento html
select com uma lista de meses. Os valores são inteiros não preenchidos e o texto são abreviações de três letras dos meses.

Exemplo:

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

Isso criaria uma lista suspensa de 12 meses, com o mês atual selecionado por padrão.

Input

Este método recebe dois valores como entrada.

name

Este é o nome do elemento html.  O padrão é 'month'

selected

Este é o item que deve ser selecionado quando a caixa de seleção for carregada. Requer um inteiro de dois dígitos.

select()

Este método cria um elemento html
select e permite que você o preencha com qualquer array unidimensional.

Exemplo:

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

O método recebe uma entrada, um array, e tem estes padrões:

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

Aqui está uma descrição do que está em cada opção:

options

Este é um array unidimensional de coisas como esta:

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

As chaves do array são usadas como valores das opções de seleção, e os valores do array são usados como texto das opções de seleção.

name

Esta seria a propriedade "name" html do elemento do formulário.  O padrão é null, obrigatório para criar um elemento de formulário útil.

id

Esta seria a propriedade "id" html do elemento html.  O padrão é vazio.

class

Esta seria a propriedade "class" do elemento html.  O padrão é vazio.

multiple

Isso torna o menu select do tipo "multiple". O padrão é false.

Exemplo:

selected

Isso permite que você forneça uma chave do seu array e tenha essa chave pré-selecionada quando o formulário carregar.  O padrão é 0.

chosen

Isso ativa o plugin "chosen" do jquery na sua caixa de seleção.  O padrão é false.

Exemplos ambos fechados e abertos:

placeholder

Este é o texto que vai na primeira linha da lista de seleção, geralmente algo como um título. O padrão é nulo.

show_option_all

Isso cria uma opção de seleção com um valor de “all” e é inserido na lista de argumentos desta forma:

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

show_option_none

Isso cria uma opção de seleção com um valor de “-1” e é inserido na lista de argumentos desta forma:

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

checkbox()

Este método cria um único
checkbox elemento html.

Nota: Esta função não cria nenhum HTML de encapsulamento como .

Exemplo:

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

O método recebe uma entrada, um array, e tem estes padrões:

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

Aqui está uma descrição do que está em cada opção:

name

Esta seria a propriedade "name" html do elemento do formulário.  O padrão é null, obrigatório para criar um elemento de formulário útil.

Nota: o nome também é usado para o ‘id’.

current

Este é o valor pré-existente do campo. Ele é usado para determinar se a caixa de seleção deve estar marcada por padrão.

class

Este é o valor do elemento html ‘class’. O padrão é ‘edd-checkbox’.

options

Isso precisa ser um array e pode conter duas opções.

• disabled – Define o campo como desabilitado ou não com true ou false.
• readonly – Define o campo como somente leitura ou não com true ou false.

text()

Este método cria um elemento html de texto simples .

Exemplo:

html->text( $args ); ?>

O método recebe uma entrada, um array, e tem estes padrões:

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

Aqui está uma descrição do que está em cada opção:

id

Esta seria a propriedade “id” html do elemento html. O padrão é vazio.

name

Esta seria a propriedade “name” html do elemento do formulário. O padrão é “text”.

value

Este é o valor pré-existente do campo. Ele é usado para preencher o campo de texto com este valor. O padrão é NULL.

label

Este é o texto envolvido em uma tag. A tag também tem uma classe “edd-label” e um elemento “for” que usa o id mencionado acima. O padrão é NULL.

desc

Este é um texto que é envolvido em um span com a classe “edd-description”. Ele é colocado entre o rótulo e a entrada. O padrão é NULL.

placeholder

Este texto é colocado no elemento “placeholder” do . A renderização depende do navegador.
Você pode ler mais sobre o elemento placeholder em w3schools. O padrão é vazio.

class

Este é o valor do elemento html ‘class’. O padrão é ‘regular-text’.

disabled

Isso define o campo como desabilitado ou não.  Booleano, o padrão é false.

autocomplete

Isso define o elemento autocomplete como “on” ou “off”.  O padrão é vazio, o que equivale a “on” na maioria dos navegadores modernos.

data

Isso aceita um array e cria elementos html de dados a partir do array. Exemplo:

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

O array acima resultaria neste html sendo colocado dentro do input:

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

O padrão é false.

textarea()

Isso cria uma área de texto HTML padrão de várias linhas.

Exemplo:

html->textarea( $args ); ?>

O método recebe uma entrada, um array, e tem estes padrões:

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

Aqui está uma descrição do que há em cada opção.

name

Esta seria a propriedade “name” do elemento do formulário no html.  O padrão é “textarea”.

value

Este é o valor pré-existente do campo. É usado para preencher previamente o campo de texto com este valor. O padrão é NULL.

label

Este é o texto envolvido em uma tag. A tag também tem uma classe “edd-label” e um elemento “for” que usa o id mencionado acima. O padrão é NULL.

desc

Este é um texto que é envolvido em uma span com a classe “edd-description”.  Ele é colocado após a tag textarea.  O padrão é NULL.

class

Este é o valor do elemento html ‘class’. O padrão é ‘large-text’.

disabled

Isso define o campo como desabilitado ou não.  Booleano, o padrão é false.

ajax_user_search()

Este método cria um campo de texto para pesquisar usuários do EDD.  Ele usa ajax para pesquisar enquanto você digita e permite que você clique para escolher um resultado para preencher o campo.

Nota: este campo só funciona em páginas de administração do EDD.  Não no front-end do WordPress, e não em outras áreas de administração do WordPress.

Exemplo:

html->ajax_user_search( $args ); ?>

O método recebe uma entrada, um array, e tem estes padrões:

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

Aqui está uma descrição do que há em cada opção.

name

Esta seria a propriedade “name” do elemento do formulário no html.  O padrão é “user_id”.

value

Este é o valor pré-existente do campo. É usado para preencher previamente o campo de texto com este valor. O padrão é NULL.

placeholder

Este texto é renderizado na caixa de input na maioria dos navegadores. O padrão é:

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

label

Este texto não aparece no front-end do site, mas é usado com aria para leitores de tela. O padrão é NULL.

class

Este é o valor do elemento html ‘class’. O padrão é vazio.

disabled

Isso define o campo como desabilitado ou não.  Booleano, o padrão é false.

autocomplete

Isso define o elemento autocomplete como “on” ou “off”.  O padrão é vazio, o que equivale a “on” na maioria dos navegadores modernos.