表單幫助文件包含有助于使用表單的功能。

• 加載此助手

• 轉義場值

• 可用職能

加載此助手

使用以下代碼加載此助手：

$this->load->helper('form');

轉義場值

您可能需要在表單元素中使用HTML和字符(如引號)。為了安全地完成這個任務，您需要使用公共函數html_escape()...

考慮以下示例：

$string = 'Here is a string containing "quoted" text.';<input type="text" name="myfield" value="<?php echo $string; ?>" />

由于上面的字符串包含一組引號，它將導致表單中斷。大html_escape()函數轉換HTML特殊字符，以便安全地使用：

<input type="text" name="myfield" value="<?php echo html_escape($string); ?>" />

注

如果使用此頁面中列出的任何表單幫助函數，則表單值將自動轉義，因此不需要調用此函數。只有在創(chuàng)建自己的表單元素時才使用它。

可用職能

現有下列職能：

form_open([$action = ''[, $attributes = ''[, $hidden = array()]]])

• $ action（string） - 表單動作/目標URI字符串

• $ attributes（array） -  HTML屬性

• $ hidden（array） - 一個隱藏字段的定義數組

返回：HTML表單開始標記

返回類型：字符串

使用從您的配置首選項**構建的基本URL **創(chuàng)建開放表單標記。它可以選擇讓你添加表單屬性和隱藏的輸入字段，并且總是添加基于配置文件中charset值的`accept-charset`屬性。

使用這個標記而不是硬編碼自己的HTML的主要好處是，它允許您的站點在URL更改時更易于移植。

下面是一個簡單的例子：

echo form_open（'email / send'）;

上面的示例將創(chuàng)建一個指向基本URL和“Email/Send”URI段的表單，如下所示：

<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send">

添加屬性

可以通過向第二個參數傳遞關聯數組來添加屬性，如下所示：

$ attributes = array（'class'=>'email'，'id'=>'myform'）; echo form_open（'email / send'，$ attributes）;

或者，可以將第二個參數指定為字符串：

echo form_open（'email / send'，'class =“email”id =“myform”'）;

上述示例將創(chuàng)建一個類似于此的形式：

<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send" class="email" id="myform">

添加隱藏輸入字段

可以通過向第三個參數傳遞關聯數組來添加隱藏字段，如下所示：

$ hidden = array（'username'=>'Joe'，'member_id'=>'234'）; echo form_open（'email / send'，''，$ hidden）;

您可以通過向第二個參數傳遞任何Falsy值來跳過第二個參數。

上面的示例將創(chuàng)建一個類似于此的表單：

<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send">         <input type="hidden" name="username" value="Joe" />         <input type="hidden" name="member\_id" value="234" />

form_open_multipart([$action = ''[, $attributes = array()[, $hidden = array()]]])

• $ action（string） - 表單動作/目標URI字符串

• $ attributes（array） -  HTML屬性

• $ hidden（array） - 一個隱藏字段的定義數組

返回：HTML多部分表單打開標記

返回類型：字符串

這個函數與上面的``form_open（）`]（about：blank＃form_open）完全相同，除了它增加了一個_multipart_屬性，如果你想使用表單來上傳文件，這是必須的。

form_hidden($name[, $value = ''])

• $ name（字符串） - 字段名稱

• $ value（字符串） - 字段值

返回：HTML隱藏的輸入字段標記

返回類型：字符串

讓您生成隱藏的輸入字段。您可以提交一個名稱/值字符串來創(chuàng)建一個字段：

form_hidden（'username'，'johndoe'）; //會產生：<input type =“hidden”name =“username”value =“johndoe”/>

...或者可以提交一個關聯數組來創(chuàng)建多個字段：

$ data = array（'name'=>'John Doe'，'email'=>'email protected'，'url'=>' http://example.com '）; echo form_hidden（$ data）; / *會產生：<input type =“hidden”name =“name”value =“John Doe”/> <input type =“hidden”name =“email”value =“[email protected]”/> <input type =“hidden”name =“url”value =“http://example.com”/> * /

還可以將關聯數組傳遞給Value字段：

$ data = array（'name'=>'John Doe'，'email'=>'email protected'，'url'=>' http://example.com '）; echo form_hidden（'my_array'，$ data）; / *會生成：<input type =“hidden”name =“my \ _array [name]”value =“John Doe”/> <input type =“hidden”name =“my \ _array [email]”value =“ [email protected]“/> <input type =”hidden“name =”my \ _array [url]“value =”http://example.com“/> * /

如果要創(chuàng)建具有額外屬性的隱藏輸入字段：

$ data = array（'type'=>'hidden'，'name'=>'email'，'id'=>'hiddenemail'，'value'=>'email protected'，'class'=>'hiddenemail' ）; echo form_input（$ data）; / *會產生：<input type =“hidden”name =“email”value =“[email protected]”id =“hiddenemail”class =“hiddenemail”/> * /

form_input([$data = ''[, $value = ''[, $extra = '']]])

• $ data（array） - 字段屬性數據

• $ value（字符串） - 字段值

• $ extra（mixed） - 要作為數組或字符串添加到標記的額外屬性

返回：HTML文本輸入字段標記

返回類型：字符串

讓您生成標準文本輸入字段。您可以最小化地傳遞第一個和第二個參數中的字段名稱和值：

echo form_input（'username'，'johndoe'）;

也可以傳遞一個關聯數組，該數組包含您希望窗體包含的任何數據：

$data = array(         'name'          => 'username',         'id'            => 'username',         'value'         => 'johndoe',         'maxlength'     => '100',         'size'          => '50',         'style'         => 'width:50%' );  echo form_input($data);  /*         Would produce:          <input type="text" name="username" value="johndoe" id="username" maxlength="100" size="50" style="width:50%"  /> */

如果希望表單包含一些附加數據，如JavaScript，則可以將其作為字符串傳遞到第三個參數中：

$ js ='onClick =“some_function（）”'; echo form_input（'username'，'johndoe'，$ js）;

也可以將其作為數組傳遞：

$ js = array（'onClick'=>'some_function（）;'）; echo form_input（'username'，'johndoe'，$ js）;

form_password([$data = ''[, $value = ''[, $extra = '']]])

• $ data（array） - 字段屬性數據

• $ value（字符串） - 字段值

• $ extra（mixed） - 要作為數組或字符串添加到標記的額外屬性

返回：HTML密碼輸入字段標記

返回類型：字符串

除了使用“password”輸入類型外，這個函數在所有方面都與[`form_input（）`]（about：blank＃form_input）函數完全相同。

form_upload([$data = ''[, $value = ''[, $extra = '']]])

• $ data（array） - 字段屬性數據

• $ value（字符串） - 字段值

• $ extra（mixed） - 要作為數組或字符串添加到標記的額外屬性

返回：HTML文件上傳輸入字段標記

返回類型：字符串

這個函數在所有方面都與上面的[`form_input（）`]（about：blank＃form_input）函數相同，除了它使用“file”輸入類型，允許它用于上傳文件。

form_textarea([$data = ''[, $value = ''[, $extra = '']]])

• $ data（array） - 字段屬性數據

• $ value（字符串） - 字段值

• $ extra（mixed） - 要作為數組或字符串添加到標記的額外屬性

Returns:  An HTML textarea tag

Return type:  string

This function is identical in all respects to the [`form_input()`](about:blank#form_input) function above except that it generates a “textarea” type.

注

取而代之的是的最大長度和尺寸在上面的例子中的屬性，你反而會指定行和COLS。

form_dropdown([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]])

• $ name（字符串） - 字段名稱

• $ options（array） - 要列出的選項的關聯數組

• $ selected（array） - 用選定屬性標記的字段列表

• $ extra（mixed） - 要作為數組或字符串添加到標記的額外屬性

Returns:  An HTML dropdown select field tag

Return type:  string

讓您創(chuàng)建一個標準的下拉字段。第一個參數將包含字段的名稱，第二個參數將包含選項的關聯數組，第三個參數將包含您希望選擇的值。您還可以通過第三個參數傳遞多個項目的數組，CodeIgniter將為您創(chuàng)建一個多選項。

例子：

''''''''小號襯衫'，'med'=>'中型襯衫'，'大號'=>'大號襯衫'，'xlarge'=>'超大號襯衫'，）; $ shirts_on_sale = array（'small'，'large'）; echo form_dropdown（'shirts'，$ options，'large'）; / *會產生：<select name =“shirts”> <option value =“small”> Small Shirt </ option> <option value =“med”> Medium Shirt </ option> <option value =“l(fā)arge”selected = “selected”> Large Shirt </ option> <option value =“xlarge”>超大襯衫</ option> </ select> * / echo form_dropdown（'shirts'，$ options，$ shirts_on_sale）; / *會產生：<select name =“shirts”multiple =“multiple”> <option value =“small”selected =“selected”>小襯衫</ option> <option value =“med”> Medium Shirt </ option > <選項值=“大”選中=“選定”>大襯衫</ option> <選項值=“xlarge”>超大襯衫</ option> </ select> * /

如果您希望打開的<select>包含其他數據（如id屬性或JavaScript），則可以將它作為字符串傳遞給第四個參數：

$ js ='id =“shirts”onChange =“some_function（）;”'; echo form_dropdown（'shirts'，$ options，'large'，$ js）;

也可以將其作為數組傳遞：

$ js = array（'id'=>'shirts'，'onChange'=>'some_function（）;'）; echo form_dropdown（'shirts'，$ options，'large'，$ js）;

如果數組作為$options是多維數組，那么form_dropdown()會產生一個<optgroup>以數組鍵作為標簽。

form_multiselect([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]])

• $ name（字符串） - 字段名稱

• $ options（array） - 要列出的選項的關聯數組

• $ selected（array） - 用選定屬性標記的字段列表

• $ extra（mixed） - 要作為數組或字符串添加到標記的額外屬性

Returns:  An HTML dropdown multiselect field tag

Return type:  string

讓您創(chuàng)建一個標準的多選字段。第一個參數將包含字段的名稱，第二個參數將包含選項的關聯數組，第三個參數將包含您希望選擇的一個或多個值。

參數用法與form_dropdown()上面的使用方法相同，當然除了字段的名稱需要使用POST數組語法，例如foo []。

form_fieldset([$legend_text = ''[, $attributes = array()]])

• $ legend_text（string） - 放入<legend>標簽的文本

• $ attributes（array） - 要在<fieldset>標簽上設置的屬性

Returns:  An HTML fieldset opening tag

Return type:  string

讓您生成fieldset / legend字段。

例子：

echo form_fieldset（'地址信息'）; 回聲“<p>此處的字段集內容</ p> \ n”; echo form_fieldset_close（）; / *生成：<fieldset> <legend>地址信息</ legend> <p>在此處填寫內容</ p> </ fieldset> * /

與其他函數類似，如果您希望設置其他屬性，則可以在第二個參數中提交關聯數組：

$ attributes = array（'id'=>'address_info'，'class'=>'address_info'）; echo form_fieldset（'Address Information'，$ attributes）; 回聲“<p>此處的字段集內容</ p> \ n”; echo form_fieldset_close（）; / *產生：<fieldset id =“地址\ _info”class =“地址\ _info”> <legend>地址信息</ legend> <p>在這里表示內容</ p> </ fieldset> * /

form_fieldset_close([$extra = ''])

• $額外（字符串） -任何給結束標記之后追加，如     返回：HTML字段集結束標記返回類型：字符串產生一個結束</字段集>標記。使用此功能的唯一好處是它允許您將數據傳遞給它，并將其添加到標簽下方。例如$ string ='</ div> </ div>'; echo form_fieldset_close（$ string）; //產生：</ fieldset> </ div> </ div> form_checkbox([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]])參數：$ data（array） - 字段屬性數據$ value（字符串） - 字段值$ checked（bool） - 是否將復選框標記為選中$ extra（mixed） - 要作為數組或字符串添加到標記的附加屬性stringReturns：HTML復選框輸入tagReturn類型：string

• $ data（array） - 字段屬性數據

• $ value（字符串） - 字段值

• $ checked（bool） - 是否將復選框標記為被選中

• $ extra（mixed） - 要作為數組或字符串添加到標記的額外屬性

Returns:  An HTML checkbox input tag

Return type:  string

讓你生成一個復選框字段。簡單的例子：

echo form_checkbox（'newsletter'，'accept'，TRUE）; //會產生：<input type =“checkbox”name =“newsletter”value =“accept”checked =“checked”/>

第三個參數包含一個布爾值true/false，以確定是否應該選中該框。

與此助手中的其他表單函數類似，您還可以將屬性數組傳遞給該函數：

$ data = array（'name'=>'newsletter'，'id'=>'newsletter'，'value'=>'accept'，'checked'=> TRUE，'style'=>'margin：10px'） ; echo form_checkbox（$ data）; //會產生：<input type =“checkbox”name =“newsletter”id =“newsletter”value =“accept”checked =“checked”style =“margin：10px”/>

與其他函數一樣，如果希望標記包含JavaScript之類的其他數據，則可以在第四個參數中將其作為字符串傳遞：

$ js ='onClick =“some_function（）”'; echo form_checkbox（'newsletter'，'accept'，TRUE，$ js）;

也可以將其作為數組傳遞：

$ js = array（'onClick'=>'some_function（）;'）; echo form_checkbox（'newsletter'，'accept'，TRUE，$ js）;

form_radio([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]])

• $ data（array） - 字段屬性數據

• $ value（字符串） - 字段值

• $ checked（bool） - 是否將單選按鈕標記為正在檢查

• $ extra（mixed） - 要作為數組或字符串添加到標記的額外屬性

Returns:  An HTML radio input tag

Return type:  string

除了使用“radio”輸入類型之外，這個函數在所有方面與[`form_checkbox（）`]（about：blank＃form_checkbox）函數完全相同。

form_label([$label_text = ''[, $id = ''[, $attributes = array()]]])

• $ label_text（string） - 放在<label>標簽中的文本

• $ id（字符串） - 我們?yōu)槠渲谱鳂撕灥谋韱卧氐腎D

• $ attributes（mixed） -  HTML屬性

Returns:  An HTML field label tag

Return type:  string

讓你生成一個<label>。簡單的例子：

echo form_label（'你的名字是什么'，'用戶名'）; //會產生：<label for =“username”>什么是您的名字</ label>

與其他函數類似，如果您喜歡設置其他屬性，則可以在第三個參數中提交關聯數組。

例子：

$ attributes = array（'class'=>'mycustomclass'，'style'=>'color：＃000;'）; 回聲form_label（'你是什么名字'，'用戶名'，$屬性）; //會產生：<label for =“username”class =“mycustomclass”style =“color：＃000;”>什么是您的名字</ label>

form_submit([$data = ''[, $value = ''[, $extra = '']]])

• $ data（字符串） - 按鈕名稱

• $ value（字符串） - 按鈕值

• $ extra（mixed） - 要作為數組或字符串添加到標記的額外屬性

Returns:  An HTML input submit tag

Return type:  string

讓你生成一個標準的提交按鈕。簡單的例子：

echo form_submit（'mysubmit'，'Submit Post！'）; //會產生：<input type =“submit”name =“mysubmit”value =“提交帖子！” />

與其他函數類似，如果您喜歡設置自己的屬性，可以在第一個參數中提交關聯數組。第三個參數允許您向表單中添加額外的數據，比如JavaScript。

form_reset([$data = ''[, $value = ''[, $extra = '']]])

• $ data（字符串） - 按鈕名稱

• $ value（字符串） - 按鈕值

• $ extra（mixed） - 要作為數組或字符串添加到標記的額外屬性

返回：HTML輸入重置按鈕標記

Return type:  string

讓您生成一個標準的重置按鈕。使用與`form_submit（）`相同。

form_button([$data = ''[, $content = ''[, $extra = '']]])

• $ data（字符串） - 按鈕名稱

• $ content（string） - 按鈕標簽

• $ extra（mixed） - 要作為數組或字符串添加到標記的額外屬性

Returns:  An HTML button tag

Return type:  string

讓你生成一個標準的按鈕元素。您可以最低限度地傳遞第一個和第二個參數中的按鈕名稱和內容：

echo form_button（'name'，'content'）; //將產生：<button name =“name”type =“button”> Content </ button>

也可以傳遞一個關聯數組，該數組包含您希望窗體包含的任何數據：

$ data = array（'name'=>'button'，'id'=>'button'，'value'=>'true'，'type'=>'reset'，'content'=>'Reset'） ; echo form_button（$ data）; //產生：<button name =“button”id =“button”value =“true”type =“reset”> Reset </ button>

如果希望表單包含一些附加數據，如JavaScript，則可以將其作為字符串傳遞到第三個參數中：

$ js ='onClick =“some_function（）”'; echo form_button（'mybutton'，'Click Me'，$ js）;

form_close([$extra = ''])

• $extra (string) – Anything to append after the closing tag, as is    Returns:  An HTML form closing tag    Return type:  string    Produces a closing </form> tag. The only advantage to using this function is it permits you to pass data to it which will be added below the tag. For example: $string = '</div></div>'; echo form_close($string); // Would produce:  </form> </div></div> set_value($field[, $default = ''[, $html_escape = TRUE]])Parameters:$field (string) – Field name  $default (string) – Default value  $html_escape (bool) – Whether to turn off HTML escaping of the valueReturns:Field valueReturn type:string

• $ field（string） - 字段名稱

• $ default（string） - 默認值

• $ html_escape（bool） - 是否關閉HTML值的轉義

Returns:  Field value

Return type:  string

允許您設置輸入表單或textarea的值。您必須通過函數的第一個參數提供字段名稱。第二個（可選）參數允許您為表單設置默認值。第三個（可選）參數允許您關閉HTML轉義值，以防需要將此函數與ie [`form_input（）`]（about：blank＃form_input）結合使用并避免雙重轉義。

例子：

<input type =“text”name =“quantity”value =“<？php echo set \ _value（'quantity'，'0'）;？>”size =“50”/>

當首次加載時，上述表單將顯示“0”。

注

如果您已經加載了表單驗證庫并設置了與此助手一起使用的字段名的驗證規(guī)則，然后將調用轉發(fā)給表單驗證庫自己的set_value()方法。否則，此函數將在$_POST字段值。

set_select($field[, $value = ''[, $default = FALSE]])

• $ field（string） - 字段名稱

• $ value（string） - 要檢查的值

• $ default（string） - 該值是否也是默認值

Returns:  ‘selected’ attribute or an empty string

Return type:  string

如果您使用<select>菜單，則此功能允許您顯示所選的菜單項。

第一個參數必須包含選擇菜單的名稱，第二個參數必須包含每個項目的值，第三個（可選）參數允許您將項目設置為默認值（使用布爾值TRUE / FALSE）。

例子：

<select name =“myselect”> <option value =“one”<？php echo set \ _select（'myselect'，'one'，TRUE）; ？>>一個</ option> <option value =“two”<？php echo set \ _select（'myselect'，'two'）; ？>>兩個</ option> <option value =“three”<？php echo set \ _select（'myselect'，'three'）; ？>>三</ option> </ select>

set_checkbox($field[, $value = ''[, $default = FALSE]])

• $ field（string） - 字段名稱

• $ value（string） - 要檢查的值

• $ default（string） - 該值是否也是默認值

Returns:  ‘checked’ attribute or an empty string

Return type:  string

允許您以提交狀態(tài)顯示復選框。

第一個參數必須包含復選框的名稱，第二個參數必須包含其值，第三個（可選）參數允許您將項目設置為默認值（使用布爾值TRUE / FALSE）。

例子：

<input type =“checkbox”name =“mycheck”value =“1”<？php echo set \ _checkbox（'mycheck'，'1'）; ？> /> <input type =“checkbox”name =“mycheck”value =“2”<？php echo set \ _checkbox（'mycheck'，'2'）; ？> />

set_radio($field[, $value = ''[, $default = FALSE]])

• $ field（string） - 字段名稱

• $ value（string） - 要檢查的值

• $ default（string） - 該值是否也是默認值

Returns:  ‘checked’ attribute or an empty string

Return type:  string

允許您以提交狀態(tài)顯示單選按鈕。這個函數與上面的``set_checkbox（）`]（about：blank＃set_checkbox）函數相同。

例子：

<input type =“radio”name =“myradio”value =“1”<？php echo set \ _radio（'myradio'，'1'，TRUE）; ？> /> <input type =“radio”name =“myradio”value =“2”<？php echo set \ _radio（'myradio'，'2'）; ？> />

注

如果您使用的是表單驗證類，則必須始終為您的字段指定規(guī)則，即使為空，以便set_*()功能開始工作。這是因為如果定義了表單驗證對象，則set_*()傳遞給類的方法，而不是泛型助手函數。

form_error([$field = ''[, $prefix = ''[, $suffix = '']]])

• $ field（string） - 字段名稱

• $ prefix（string） - 打開標簽時出錯

• $ suffix（string） - 錯誤結束標記

返回：HTML格式的表單驗證錯誤消息（s）

Return type:  string

從[Form Validation Library]（../ libraries / form_validation）返回驗證錯誤消息，與指定的字段名稱關聯。您可以選擇指定打開和關閉標簽以放置錯誤消息。

例子：

//假設'username'字段值不正確：echo form_error（'myfield'，'<div class =“error”>'，'</ div>'）; //將產生：<div class =“error”>與“用戶名”字段相關聯的錯誤消息。</ div>

validation_errors([$prefix = ''[, $suffix = '']])

• $ prefix（string） - 打開標簽時出錯

• $ suffix（string） - 錯誤結束標記

返回：HTML格式的表單驗證錯誤消息（s）

Return type:  string

與[`form_error（）`]（about：blank＃form_error）函數類似，返回由[Form Validation Library]（../ libraries / form_validation）生成的所有驗證錯誤消息，每個消息周圍都有可選的開始和結束標記消息。

例子：

echo validation_errors（'<span class =“error”>'，'</ span>'）; / *會產生，例如：<span class =“error”>“email”字段不包含有效的電子郵件地址！</ span> <span class =“error”>“password”字段doesn' t匹配“repeat_password”字段！</ span> * /

form_prep($str)

• $ str（string） - 要轉義的值

返回：轉義值

Return type:  string

允許您安全地在表單元素中使用HTML和字符（如引號），而不會破壞表單。

注

如果您使用此頁面中列出的任何表單幫助函數，則表單值將自動準備，因此不需要調用此函數。只有在創(chuàng)建自己的表單元素時才使用它。

注

這個函數是不推薦的，它只是一個別名。公共函數html_escape()-請用這個代替。