sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve inline documentation for submit_button().

Browse Source 
See #27070.


git-svn-id: https://develop.svn.wordpress.org/trunk@27136 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2014-02-08 22:13:18 +00:00
parent 622d3e1338
commit 4993a00e05
1 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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