cakephp-1.3 > FormHelper :: submit()
A AclBase AclBehavior AclComponent AclNode AclShell Aco AcoAction AjaxHelper ApcEngine ApiShell App AppController AppController AppHelper AppHelper AppModel AppModel Aro AuthComponent B BakeShell BakeTask BehaviorCollection C Cache CacheEngine CacheHelper CakeErrorController CakeLog CakeRoute CakeSchema CakeSession CakeSocket ClassRegistry Component Configure ConnectionManager ConsoleShell ContainableBehavior Controller ControllerTask CookieComponent D DataSource DbAcl DbAclSchema DbConfigTask DboMssql DboMysql DboMysqlBase DboMysqli DboOracle DboPostgres DboSource DboSqlite Debugger Dispatcher E EmailComponent ErrorHandler ErrorHandler ExtractTask F File FileEngine FileLog FixtureTask Folder FormHelper H Helper HtmlHelper HttpSocket I I18n I18nModel i18nSchema I18nShell Inflector IniAcl J JavascriptHelper JqueryEngineHelper JsBaseEngineHelper JsHelper L L10n M MagicDb MagicFileResource MediaView MemcacheEngine Model ModelBehavior ModelTask MootoolsEngineHelper Multibyte N NumberHelper O Object Overloadable Overloadable Overloadable2 Overloadable2 P PagesController PagesController PaginatorHelper Permission PluginShortRoute PluginTask ProjectTask PrototypeEngineHelper R RequestHandlerComponent Router RssHelper S Sanitize Scaffold ScaffoldView SchemaShell Security SecurityComponent SessionComponent SessionHelper SessionsSchema Set Shell ShellDispatcher String T TemplateTask TestSuiteShell TestTask TextHelper ThemeView TimeHelper TranslateBehavior TreeBehavior V Validation View ViewTask X XcacheEngine Xml XmlElement XmlHelper XmlManager XmlNode XmlTextNode

submit

line:1318 at /cake/libs/view/helpers/form.php
Creates a submit button element. This method will generate `<input />` elements that can be used to submit, and reset forms by using $options. image submits can be created by supplying an image path for $caption.

Method

(string) submit ($caption = null, $options = array())

Parameters

ParameterTypeCommentDefault
$caption string optional The label appearing on the button OR if string contains :// or the extension .jpg, .jpe, .jpeg, .gif, .png use an image if the extension exists, AND the first character is /, image is relative to webroot, OR if the first character is not /, image is relative to webroot/img. null
$options array optional Array of options. See above. array()

Return

string

Comment

Creates a submit button element. This method will generate `<input />` elements that
can be used to submit, and reset forms by using $options. image submits can be created by supplying an
image path for $caption.

### Options

- `div` - Include a wrapping div? Defaults to true. Accepts sub options similar to
FormHelper::input().
- `before` - Content to include before the input.
- `after` - Content to include after the input.
- `type` - Set to 'reset' for reset inputs. Defaults to 'submit'
- Other attributes will be assigned to the input element.

### Options

- `div` - Include a wrapping div? Defaults to true. Accepts sub options similar to
FormHelper::input().
- Other attributes will be assigned to the input element.

@param string $caption The label appearing on the button OR if string contains :// or the
extension .jpg, .jpe, .jpeg, .gif, .png use an image if the extension
exists, AND the first character is /, image is relative to webroot,
OR if the first character is not /, image is relative to webroot/img.
@param array $options Array of options. See above.
@return string A HTML submit button
@access public
@link http://book.cakephp.org/view/1431/submit