Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-09-29 07:37:44 +02:00
Code Issues Projects Releases Wiki Activity

Improve inline documentation for submit_button().

Browse Source 
See #27070.

Built from https://develop.svn.wordpress.org/trunk@27136


git-svn-id: http://core.svn.wordpress.org/trunk@27003 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-02-08 22:14:12 +00:00
parent de97319ad8
commit 8b3c9c6b97
1 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
wp-admin/includes/template.php
View File

@ -1613,22 +1613,26 @@ function compression_test() {
}
/**
* Echos a submit button, with provided text and appropriate class
* Echoes a submit button, with provided text and appropriate class(es).
*
* @since 3.1.0
*
* @param string $text The text of the button (defaults to 'Save Changes')
* @see get_submit_button()
*
* @param string $text The text of the button (defaults to 'Save Changes')
* @param string $type Optional. The type and CSS class(es) of the button. Core values
* include 'primary', 'secondary', 'delete'. Default 'primary'
* @param string $name The HTML name of the submit button. Defaults to "submit". If no id attribute
* is given in $other_attributes below, $name will be used as the button's id.
* @param bool $wrap True if the output button should be wrapped in a paragraph tag,
* false otherwise. Defaults to true
* @param array|string $other_attributes Other attributes that should be output with the button,
* mapping attributes to their values, such as array( 'tabindex' => '1' ).
* These attributes will be output as attribute="value", such as tabindex="1".
* Defaults to no other attributes. Other attributes can also be provided as a
* string such as 'tabindex="1"', though the array format is typically cleaner.
* @param string $name The HTML name of the submit button. Defaults to "submit". If no
* id attribute is given in $other_attributes below, $name will be
* used as the button's id.
* @param bool $wrap True if the output button should be wrapped in a paragraph tag,
* false otherwise. Defaults to true
* @param array|string $other_attributes Other attributes that should be output with the button, mapping
* attributes to their values, such as setting tabindex to 1, etc.
* These key/value attribute pairs will be output as attribute="value",
* where attribute is the key. Other attributes can also be provided
* as a string such as 'tabindex="1"', though the array format is
* preferred. Default null.
*/
function submit_button( $text = null, $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = null ) {
echo get_submit_button( $text, $type, $name, $wrap, $other_attributes );