English (United Kingdom)
Knowledge Base  >  Vik Appointments  >  Hooks  >  Site Pages  >  User  >  Display Registration Form

apply_filters( 'vikappointments_display_user_registration_form', string $html, string $location )

Fires while displaying the form to register.


Description

Trigger event to let the plugins add custom HTML contents within the registration form. This hook fires several times, once for each supported location.

The following image indicates where the resulting HTML can be appended.


Parameters

$html

(string)  The HTML to include.

$location

(string)  The position in which the HTML code will be placed.

  • top - at the beginning of the registration form;
  • name - after the nominative fields;
  • username - after the username field;
  • email - after the e-mail field;
  • password - after the password fields;
  • captcha - after the CAPTCHA field;
  • policy - after the privacy policy field;
  • bottom - at the end of the registration form.

Example

/**
 * Trigger event to let the plugins add custom HTML contents within the user registration form.
 *
 * @param  string  $html      The HTML string to include within the document.
 * @param  string  $location  The HTML will be always placed after the specified location.
 */
add_filter('vikappointments_display_user_registration_form', function($html, $location)
{
    if ($location == 'password')
    {
        // append custom HTML after the password field
        $html .= '<code>HTML CODE WILL BE ADDED HERE</code>';   
    }

    return $html;
}, 10, 2);

Changelog

Version Description
1.2 Introduced.
Last Update: 2021-07-30
Helpful?