submit_button()
Выводит на экран кнопку submit с указанным текстом и классами.
Работает только в админ-панели. Подключите файл, если эта функция нужна на фронте:
require_once ABSPATH . '/wp-admin/includes/template.php';
Используйте get_submit_button(), чтобы получить результат в переменную.
Хуков нет.
Возвращает
null. Ничего. Выводит на экран html тег <input type=submit>.
Использование
submit_button( $text, $type, $name, $wrap, $other_attributes );
- $text(строка)
- Текст кнопки.
По умолчанию: null __('Save Changes') - $type(строка)
- Тип и CSS класс кнопки. Может быть: 'primary', 'secondary', 'delete' или произвольный класс.
По умолчанию: 'primary' - $name(строка)
- Атрибут name кнопки submit. Если в аргументе
idследующего параметра $other_attributes ничего не указано, то id будет равен $name.
По умолчанию: 'submit' - $wrap(логический)
- Ставим true, если кнопку нужно обернуть в тег <p>.
По умолчанию: true - $other_attributes(массив/строка)
- Массив устанавливающий атрибуты тега input по такому шаблону:
attribute => valueпревратиться в attribute="value". Можно передать строку например:'tabindex="1"'.
По умолчанию: null
Примеры
#1 Демонстрация работы
submit_button( 'Применить', 'action', '', false, [ 'id' => "doaction2" ] ); // выведет: // <input type="submit" id="doaction2" class="button action" value="Применить">
#2 Отображение вторичной кнопки
WordPress по-разному оформляет основную и дополнительную кнопки. Основная кнопка синего цвета и больше выделяется, дополнительная кнопка серая и не так бросается в глаза.
По умолчанию submit_button() выводит основную кнопку. Чтобы вывести вместо неё дополнительную кнопку, установите $type = 'secondary':
submit_button( __( 'Reset', 'textdomain' ), 'secondary' );
#3 Отображение кнопки удаления
По умолчанию в WordPress нет стилей для кнопки "Удалить". Однако, возможно, в будущем это изменится, поэтому при отображении кнопки удаления лучше указать $type как 'delete':
submit_button( __( 'Delete', 'textdomain' ), 'delete' );
По умолчанию кнопка удаления стилизуется как дополнительная (вторичная), а не как основная. Если вы хотите отобразить ее как основную кнопку, вы можете сделать это следующим образом:
submit_button( __( 'Delete', 'textdomain' ), 'delete button-primary' );
#4 Using the $name Parameter
Параметр $name можно использовать, если вы хотите установить HTML-атрибут name для кнопки. По умолчанию там значение submit.
submit_button( __( 'Save Settings', 'textdomain' ), 'primary', 'wpdocs-save-settings' );
По умолчанию $name также используется для заполнения атрибута id кнопки. Чтобы изменить это, вы можете передать id через параметр $other_attributes:
$other_attributes = [ 'id' => 'wpdocs-button-id' ]; submit_button( __( 'Save', 'textdomain' ), 'primary', 'wpdocs-save-settings', true, $other_attributes );
#5 Использование параметра $wrap
Параметр $wrap определяет, будет ли кнопка обернута в тег <p> - это по умолчанию. Чтобы отключить это поведение, передайте false для четвертого параметра:
submit_button( __( 'Submit', 'textdomain' ), 'primary', 'submit-form', false );
#6 Указание других атрибутов HTML
Вы можете добавить любые HTML-атрибуты для кнопки - используя параметр $other_attributes:
$other_attributes = [ 'tabindex' => '1' ]; submit_button( __( 'Go!', 'textdomain' ), 'secondary', '', true, $other_attributes );
Заметки
- Смотрите: get_submit_button()
Список изменений
| С версии 3.1.0 | Введена. |
Код submit_button() submit button WP 6.5.2
function submit_button( $text = '', $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = '' ) {
echo get_submit_button( $text, $type, $name, $wrap, $other_attributes );
}