BuddyClients Docs

form.php

Table of Contents

Functions

buddyc_build_form()  : mixed
Generates a new Form.
buddyc_echo_form()  : mixed
Generates a new Form.

Functions

buddyc_build_form()

Generates a new Form.

buddyc_build_form(array<string|int, mixed> $args) : mixed
Parameters
$args : array<string|int, mixed>

{ An array of arguments to create the form.

@type    string      $key                    The form key.
@type    callable    $fields_callback        The callback to generate the form fields.
@type    string      $submission_class       The class that handles the form submission.
@type    bool        $submit_button          Optional. Whether to include a submit button.
@type    string      $submit_text            Optional. The text of the submit button.
                                             Defaults to 'Submit'.
@type    string      $submit_classes         Optional. Classes to apply to the submit button.
@type    array       $values                 Optional. A keyed array of values to populate the form fields.
@type    int         $avatar                 Optional. Creates a user avatar above the form.
@type    string      $form_classes           Optional. Classes to apply to the form.

}

Tags
since
1.0.21

buddyc_echo_form()

Generates a new Form.

buddyc_echo_form(array<string|int, mixed> $args) : mixed
Parameters
$args : array<string|int, mixed>

{ An array of arguments to create the form.

@type    string      $key                    The form key.
@type    callable    $fields_callback        The callback to generate the form fields.
@type    string      $submission_class       The class that handles the form submission.
@type    bool        $submit_button          Optional. Whether to include a submit button.
@type    string      $submit_text            Optional. The text of the submit button.
                                             Defaults to 'Submit'.
@type    string      $submit_classes         Optional. Classes to apply to the submit button.
@type    array       $values                 Optional. A keyed array of values to populate the form fields.
@type    int         $avatar                 Optional. Creates a user avatar above the form.
@type    string      $form_classes           Optional. Classes to apply to the form.

}

Tags
since
1.0.21

        
On this page

Search results