EDD_HTML_Elements

EDD_HTML_Elements クラスは、一貫したマークアップ、クラス名、属性を使用して、一般的に使用されるHTMLフィールドをレンダリングするためのヘルパーメソッドを提供します。

このクラスには、次のフィールドタイプのメソッドが含まれています。

product_dropdown()

このメソッドは、商品を含む
select HTML要素を作成します。値はproduct_idで、テキストはダウンロードタイトルです。

例:

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

これにより、商品のドロップダウンリストが作成されます。 このメソッドは1つの入力（配列）を受け取り、次のデフォルト値があります。

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

各オプションの内容の説明です。

name

これは、フォーム要素のHTMLの「name」プロパティになります。 デフォルトは「products」です。

例:

id

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

	Example:

class

これは、HTML要素の「class」プロパティになります。 デフォルトはありません。

例:

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

これは、HTML要素のHTML「id」プロパティになります。 デフォルトは「customers」です。

例:

class

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

	Example:

multiple

これにより、selectメニューが「multiple」タイプになります。デフォルトはfalseです。

例:

selected

これにより、customer_idを指定して、フォームの読み込み時にその顧客が事前に選択されるようになります。 デフォルトは0です。

chosen

これにより、selectボックスに「chosen」jQueryプラグインが適用されます。 デフォルトはfalseです。

閉じている場合と開いている場合の例:

number

これにより、リスト内の顧客の数に制限を設定できます。 デフォルトは30です。

placeholder

これは、selectリストの最初の行に入るテキストで、通常はタイトルのようなものです。デフォルトは「Select a Customer」です。

discount_dropdown()

このメソッドは、割引のリストを含む
select HTML要素を作成します。値はdiscount_idで、テキストは割引のタイトルです。

例:

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

これにより、割引のドロップダウンリストが作成されます。

入力

このメソッドは3つの値（入力）を受け取ります。

name

これはHTML要素の名前です。 デフォルトは「edd_discounts」です。

selected

選択ボックスの読み込み時に選択されるべき項目です。デフォルトでは何も選択されておらず、リストの最初の割引がデフォルト項目となります。

ステータス

割引はアクティブまたは非アクティブにできます。「ステータス」オプションではどちらかを選択できます。デフォルトでは宣言されず、すべての割引が読み込まれます。

category_dropdown()

このメソッドは、ダウンロードカテゴリのリストを含む
select HTML要素を作成します。値はterm_idで、テキストはカテゴリのタイトルです。

例:

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

これにより、ダウンロードカテゴリのドロップダウンリストが作成されます。

入力

このメソッドは2つの値を入力として受け取ります。

name

これはHTML要素の名前です。デフォルトは「edd_categories」です。

selected

選択ボックスの読み込み時に選択されるべき項目です。デフォルトでは何も選択されておらず、選択ボックスには「すべてのカテゴリ」というタイトルのオプションが表示されます。

year_dropdown()

このメソッドは、年リストを含む
select HTML要素を作成します。テキストとオプション値はどちらも4桁の年です。

例:

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

これにより、現在の年がデフォルトで選択された6年間のドロップダウンリストが作成されます。

入力

このメソッドは2つの値を入力として受け取ります。

name

これはHTML要素の名前です。デフォルトは「year」です。

selected

選択ボックスの読み込み時に選択されるべき項目です。4桁の整数が必要です。

month_dropdown()

このメソッドは、月リストを含む
select HTML要素を作成します。値はパディングされていない整数で、テキストは月の3文字の略語です。

例:

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

これにより、現在の月がデフォルトで選択された12か月のドロップダウンリストが作成されます。

入力

このメソッドは2つの値を入力として受け取ります。

name

これはHTML要素の名前です。デフォルトは「month」です。

selected

選択ボックスの読み込み時に選択されるべき項目です。2桁の整数が必要です。

select()

このメソッドは
select HTML要素を作成し、任意の単一ディメンション配列でそれを埋めることができます。

例:

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

このメソッドは1つの入力（配列）を受け取り、以下のデフォルトがあります：

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

各オプションの内容の説明です。

options

これは、次のような単一ディメンション配列です：

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

配列のキーは選択オプションの値として使用され、配列の値は選択オプションのテキストとして使用されます。

name

これは、フォーム要素のHTML「name」プロパティになります。デフォルトはnullで、有用なフォーム要素を作成するには必須です。

id

これは、HTML要素のHTML「id」プロパティになります。デフォルトは空です。

class

これは、HTML要素の「class」プロパティになります。デフォルトは空です。

multiple

これにより、selectメニューが「multiple」タイプになります。デフォルトはfalseです。

例:

selected

これにより、配列のキーを指定し、フォーム読み込み時にそのキーが事前に選択されるようにすることができます。デフォルトは0です。

chosen

これにより、selectボックスに「chosen」jQueryプラグインが適用されます。 デフォルトはfalseです。

例：閉じている場合と開いている場合：

placeholder

これは選択リストの最初の行に入るテキストで、通常はタイトルのようなものです。デフォルトはnullです。

show_option_all

これは値が「all」の選択オプションを作成し、次のように引数リストに挿入されます。

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

show_option_none

これは値が「-1」の選択オプションを作成し、次のように引数リストに挿入されます。

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

checkbox()

このメソッドは、単一の
checkbox HTML要素を作成します。

注意: この関数は、のようなラッパーHTMLを作成しません。

例:

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

このメソッドは1つの入力（配列）を受け取り、以下のデフォルトがあります：

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

各オプションの内容の説明です。

name

これは、フォーム要素のHTML「name」プロパティになります。デフォルトはnullで、有用なフォーム要素を作成するには必須です。

注意: nameは「id」にも使用されます。

current

これはフィールドの既存の値です。チェックボックスがデフォルトでチェックされるかどうかを判断するために使用されます。

class

これは「class」HTML要素の値です。デフォルトは「edd-checkbox」です。

options

これは配列である必要があり、2つのオプションを含めることができます。

• disabled – フィールドを無効にするかどうかの設定（trueまたはfalse）。
• readonly – フィールドを読み取り専用にするかどうかの設定（trueまたはfalse）。

text()

このメソッドは、プレーンテキストの HTML要素を作成します。

例:

html->text( $args ); ?>

このメソッドは1つの入力（配列）を受け取り、以下のデフォルトがあります：

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

各オプションの内容の説明です。

id

これはHTML要素のHTML「id」プロパティになります。 デフォルトは空です。

name

これはフォーム要素のHTML「name」プロパティになります。 デフォルトは「text」です。

価値を計算できます

これはフィールドの既存の値です。この値でテキストフィールドを事前入力するために使用されます。デフォルトはNULLです。

label

これはタグ。  タグには「edd-label」というクラスと、上記のIDを使用する「for」要素もあります。デフォルトはNULLです。でラップされたテキストです

desc

これは「edd-description」というクラスのspanでラップされたテキストです。 ラベルと入力の間に配置されます。 デフォルトはNULLです。

placeholder

このテキストは、の「placeholder」要素に配置されます。 レンダリングはブラウザに依存します。 
placeholder要素の詳細についてはw3schoolsで確認できます。 デフォルトは空です。

class

これは「class」HTML要素の値です。デフォルトは「regular-text」です。

disabled

これはフィールドを無効にするかどうかの設定です。 ブール値、デフォルトはfalseです。

オートコンプリート

これにより、オートコンプリート要素が「オン」または「オフ」に設定されます。 デフォルトは空で、ほとんどの最新ブラウザではオンと同等になります。

データ

配列を受け取り、配列からデータHTML要素を作成します。例:

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

上記の配列は、入力内に配置されるこのHTMLの結果になります:

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

デフォルトは false です。

textarea()

標準的な複数行HTMLテキストエリアを作成します。

例:

html->textarea( $args ); ?>

このメソッドは1つの入力（配列）を受け取り、以下のデフォルトがあります：

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

各オプションに含まれる内容の説明を以下に示します。

name

これは、フォーム要素のHTML「name」プロパティになります。 デフォルトは「textarea」です。

価値を計算できます

これはフィールドの事前設定値です。この値でテキストフィールドを事前に入力するために使用されます。デフォルトは NULL です。

label

これはタグ。  タグには「edd-label」というクラスと、上記のIDを使用する「for」要素もあります。デフォルトはNULLです。でラップされたテキストです

desc

これは、「edd-description」クラスのspanにラップされたテキストです。 テキストエリアタグの後に配置されます。 デフォルトは NULL です。

class

これは「class」HTML要素の値です。デフォルトは「large-text」です。

disabled

これはフィールドを無効にするかどうかの設定です。 ブール値、デフォルトはfalseです。

ajax_user_search()

このメソッドは、EDDユーザーを検索するためのテキストフィールドを作成します。 入力中に ajax で検索し、結果をクリックして選択するとフィールドが入力されます。

注意: このフィールドは EDD 管理ページでのみ機能します。 WordPress のフロントエンドや他の WordPress 管理エリアでは機能しません。

例:

html->ajax_user_search( $args ); ?>

このメソッドは1つの入力（配列）を受け取り、以下のデフォルトがあります：

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

各オプションに含まれる内容の説明を以下に示します。

name

これは、フォーム要素のHTML「name」プロパティになります。 デフォルトは「user_id」です。

価値を計算できます

これはフィールドの事前設定値です。この値でテキストフィールドを事前に入力するために使用されます。デフォルトは NULL です。

placeholder

このテキストは、ほとんどのブラウザで入力ボックスにレンダリングされます。デフォルトは次のとおりです。

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

label

この テキストはサイトのフロントエンドには表示されませんが、スクリーンリーダー用の aria で使用されます。デフォルトは NULL です。

class

これは「class」HTML要素の値です。デフォルトは空です。

disabled

これはフィールドを無効にするかどうかの設定です。 ブール値、デフォルトはfalseです。

オートコンプリート

これにより、オートコンプリート要素が「オン」または「オフ」に設定されます。 デフォルトは空で、ほとんどの最新ブラウザではオンと同等になります。