wp_login_form()

Предоставляет простую форму входа для использования в любом месте WordPress
Функция WordPress
INT 3.0.0
WordPress Icon
Содержание
  1. Описание функции
  2. Примеры использования
  3. Генерация формы авторизации
  4. Настройка внешнего вида формы
  5. Перенаправление после авторизации
  6. Изменение меток полей формы
  7. Вопросы и ответы
  8. Как изменить метку поля для ввода имени пользователя или адреса электронной почты?
  9. Как изменить метку поля для ввода пароля?
  10. Как изменить метку поля для запоминания пользователя?
  11. Как изменить метку кнопки входа?
  12. Как изменить значение по умолчанию для поля имени пользователя?
  13. Как изменить значение по умолчанию для поля запоминания пользователя?
  14. Как изменить ID атрибута для формы?
  15. Как изменить ID атрибута для поля имени пользователя?
  16. Как изменить ID атрибута для поля пароля?
  17. Связанные элементы

Описание функции

Функция wp_login_form() предоставляет простую форму входа для использования в любом месте в WordPress. Она генерирует HTML-код формы входа, который можно отобразить на странице или получить в виде строки.

Использование

wp_login_form( array $args = array() ): void|string

Функция wp_login_form() принимает один необязательный параметр — массив $args, который содержит опции для управления выводом формы. По умолчанию, форма будет отображаться на странице.

  • echo (bool): Определяет, нужно ли отображать форму входа или вернуть HTML-код формы. По умолчанию — true (отображать).
  • redirect (string): URL для перенаправления после входа. Должен быть абсолютным, например, «https://example.com/mypage/». По умолчанию — перенаправление на текущий URI запроса.
  • form_id (string): Значение атрибута ID для формы. По умолчанию — «loginform».
  • label_username (string): Текст метки для поля имени пользователя или адреса электронной почты. По умолчанию — «Username or Email Address».
  • label_password (string): Текст метки для поля пароля. По умолчанию — «Password».
  • label_remember (string): Текст метки для поля «Remember Me». По умолчанию — «Remember Me».
  • label_log_in (string): Текст метки для кнопки «Log In». По умолчанию — «Log In».
  • id_username (string): Значение атрибута ID для поля имени пользователя. По умолчанию — «user_login».
  • id_password (string): Значение атрибута ID для поля пароля. По умолчанию — «user_pass».
  • id_remember (string): Значение атрибута ID для поля «Remember Me». По умолчанию — «rememberme».
  • id_submit (string): Значение атрибута ID для кнопки «Log In». По умолчанию — «wp-submit».
  • remember (bool): Определяет, нужно ли отображать флажок «Remember Me» в форме. По умолчанию — true.
  • value_username (string): Значение по умолчанию для поля имени пользователя. По умолчанию — пустая строка.
  • value_remember (bool): Определяет, должен ли флажок «Remember Me» быть выбранным по умолчанию. По умолчанию — false.

Функция возвращает либо void, если аргумент echo равен true (по умолчанию), либо HTML-код формы входа, если аргумент echo равен false.

<?php
$args = array(
  'echo' => false,
  'redirect' => 'https://example.com/dashboard/',
  'form_id' => 'custom-login-form',
  'label_username' => 'Your Username',
  'label_password' => 'Your Password',
  'label_remember' => 'Remember Me',
  'label_log_in' => 'Sign In',
  'id_username' => 'custom-username',
  'id_password' => 'custom-password',
  'id_remember' => 'custom-remember',
  'id_submit' => 'custom-submit',
  'remember' => true,
  'value_username' => '',
  'value_remember' => false
);
$form_html = wp_login_form( $args );
echo $form_html;
?>

В этом примере мы создаем пользовательскую форму входа с различными настройками. HTML-код формы сохраняется в переменной $form_html и затем отображается на странице.

Примеры использования

Генерация формы авторизации


$args = array(
    'echo' => false
);
$login_form = wp_login_form($args);
echo $login_form;

Функция wp_login_form() генерирует форму авторизации для использования в любом месте WordPress. По умолчанию она отображает форму авторизации, но если передать параметр echo со значением false, она вернет HTML-код формы авторизации.

Настройка внешнего вида формы


$args = array(
    'echo' => false,
    'form_id' => 'custom-login-form',
    'label_username' => 'Your Username',
    'label_password' => 'Your Password',
    'label_remember' => 'Remember Me',
    'label_log_in' => 'Sign In',
    'id_username' => 'custom-username',
    'id_password' => 'custom-password',
    'id_remember' => 'custom-remember',
    'id_submit' => 'custom-submit',
    'remember' => false
);
$login_form = wp_login_form($args);
echo $login_form;

В этом примере мы настраиваем внешний вид формы авторизации. Мы изменяем ID формы, метки полей, текст кнопки отправки и ID полей. Также мы отключаем отображение чекбокса «Remember Me».

Перенаправление после авторизации


$args = array(
    'echo' => false,
    'redirect' => 'https://example.com/dashboard/'
);
$login_form = wp_login_form($args);
echo $login_form;

В этом примере мы настраиваем перенаправление пользователя на указанный URL после успешной авторизации. По умолчанию пользователь будет перенаправлен на текущую страницу.

Изменение меток полей формы


$args = array(
    'echo' => false,
    'label_username' => 'Your Email',
    'label_password' => 'Your Secret Password',
    'label_remember' => 'Remember Me',
    'label_log_in' => 'Log In'
);
$login_form = wp_login_form($args);
echo $login_form;

В этом примере мы изменяем метки полей формы авторизации. Мы меняем метку поля «Username» на «Your Email», метку поля «Password» на «Your Secret Password», метку поля «Remember Me» на «Remember Me» и метку кнопки отправки на «Log In».

Вопросы и ответы

Как изменить метку поля для ввода имени пользователя или адреса электронной почты?

Для изменения метки поля ввода имени пользователя или адреса электронной почты используется параметр label_username в функции wp_login_form(). По умолчанию метка имеет значение «Username or Email Address».


$args = array(
    'label_username' => 'Your Custom Label',
);
wp_login_form( $args );

Как изменить метку поля для ввода пароля?

Для изменения метки поля ввода пароля используется параметр label_password в функции wp_login_form(). По умолчанию метка имеет значение «Password».


$args = array(
    'label_password' => 'Your Custom Label',
);
wp_login_form( $args );

Как изменить метку поля для запоминания пользователя?

Для изменения метки поля запоминания пользователя используется параметр label_remember в функции wp_login_form(). По умолчанию метка имеет значение «Remember Me».


$args = array(
    'label_remember' => 'Your Custom Label',
);
wp_login_form( $args );

Как изменить метку кнопки входа?

Для изменения метки кнопки входа в форме авторизации, нужно использовать параметр label_log_in при вызове функции wp_login_form(). По умолчанию, метка кнопки имеет значение «Log In».


$args = array(
    'label_log_in' => 'Войти',
);
wp_login_form( $args );

Как изменить значение по умолчанию для поля имени пользователя?

Для изменения значения по умолчанию для поля имени пользователя в форме авторизации, нужно использовать параметр value_username при вызове функции wp_login_form(). По умолчанию, поле имеет пустое значение.


$args = array(
    'value_username' => 'Введите имя пользователя',
);
wp_login_form( $args );

Как изменить значение по умолчанию для поля запоминания пользователя?

Для изменения значения по умолчанию для поля запоминания пользователя в форме авторизации, нужно использовать параметр value_remember при вызове функции wp_login_form(). По умолчанию, поле не отмечено.


$args = array(
    'value_remember' => true,
);
wp_login_form( $args );

Как изменить ID атрибута для формы?

Для изменения ID атрибута формы при использовании функции wp_login_form(), нужно передать параметр form_id со значением нового ID. По умолчанию ID равен ‘loginform’.


$args = array(
    'form_id' => 'my-login-form'
);
wp_login_form( $args );

Как изменить ID атрибута для поля имени пользователя?

Для изменения ID атрибута поля имени пользователя при использовании функции wp_login_form(), нужно передать параметр id_username со значением нового ID. По умолчанию ID равен ‘user_login’.


$args = array(
    'id_username' => 'my-username-field'
);
wp_login_form( $args );

Как изменить ID атрибута для поля пароля?

Для изменения ID атрибута поля пароля при использовании функции wp_login_form(), нужно передать параметр id_password со значением нового ID. По умолчанию ID равен ‘user_pass’.


$args = array(
    'id_password' => 'my-password-field'
);
wp_login_form( $args );

Функция wp_login_form() предоставляет простую форму входа для использования в любом месте в WordPress. Она возвращает HTML-код формы входа или отображает его на экране в зависимости от переданного параметра. Функция также предоставляет возможность настроить различные атрибуты формы и полей, такие как ID, заголовки и значения по умолчанию. Это очень удобно для разработчиков WordPress, которые хотят создавать пользовательские формы входа с определенными настройками.

Связанные элементы

  • Функция wp_login_url(): возвращает URL для страницы входа в систему.
  • Функция wp_logout_url(): возвращает URL для страницы выхода из системы.
  • Функция wp_lostpassword_url(): возвращает URL для страницы восстановления пароля.
  • Функция wp_registration_url(): возвращает URL для страницы регистрации нового пользователя.
  • Функция wp_set_auth_cookie(): устанавливает аутентификационные куки для пользователя.
  • Функция wp_clear_auth_cookie(): удаляет аутентификационные куки пользователя.
  • Функция wp_validate_auth_cookie(): проверяет правильность аутентификационных куки пользователя.
  • Функция wp_signon(): выполняет вход пользователя в систему.
Аутентификация Формы
Обсуждение

Этот сайт использует cookie для хранения данных. Продолжая использовать сайт, Вы принимаете условия пользовательского соглашения и даете свое согласие на использование cookie.