Elgg  Version 4.x
Functions
input.php File Reference

Go to the source code of this file.

Functions

 get_input ($variable, $default=null, $filter_result=true)
 Parameter input functions. More...
 
 set_input ($variable, $value)
 Sets an input value that may later be retrieved by get_input. More...
 
 elgg_get_request_data ($filter_result=true)
 Returns all values parsed from the current request, including $_GET and $_POST values, as well as any values set with set_input() More...
 
 elgg_get_title_input ($variable= 'title', $default= '')
 Get an HTML-escaped title from input. More...
 
 filter_tags ($var)
 Filter tags from a given string based on registered hooks. More...
 
 current_page_url ()
 Returns the current page's complete URL. More...
 
 is_email_address ($address)
 Validates an email address. More...
 
 elgg_make_sticky_form ($form_name, array $ignored_field_names=[])
 Save form submission data (all GET and POST vars) into a session cache. More...
 
 elgg_clear_sticky_form ($form_name)
 Remove form submission data from the session. More...
 
 elgg_is_sticky_form ($form_name)
 Does form submission data exist for this form? More...
 
 elgg_get_sticky_value ($form_name, $variable= '', $default=null, $filter_result=true)
 Get a specific value from cached form submission data. More...
 
 elgg_get_sticky_values ($form_name, $filter_result=true)
 Get all submission data cached for a form. More...
 
 elgg_clear_sticky_value ($form_name, $variable)
 Remove one value of form submission data from the session. More...
 
 elgg_is_empty ($value)
 Check if a value isn't empty, but allow 0 and '0'. More...
 
 _elgg_htmlawed_tag_post_processor ($element, $attributes=false)
 Post processor for tags in htmlawed. More...
 
 string_to_tag_array ($string)
 Takes in a comma-separated string and returns an array of tags which have been trimmed. More...
 

Function Documentation

_elgg_htmlawed_tag_post_processor (   $element,
  $attributes = false 
)

Post processor for tags in htmlawed.

This runs after htmlawed has filtered. It runs for each tag and filters out style attributes we don't want.

This function triggers the 'allowed_styles', 'htmlawed' plugin hook.

Parameters
string$elementThe tag element name
array$attributesAn array of attributes
Returns
string

Definition at line 219 of file input.php.

current_page_url ( )

Returns the current page's complete URL.

It uses the configured site URL for the hostname rather than depending on what the server uses to populate $_SERVER.

Returns
string The current page URL.

Definition at line 89 of file input.php.

elgg_clear_sticky_form (   $form_name)

Remove form submission data from the session.

Call this if validation is successful in the action handler or when they sticky values have been used to repopulate the form after a validation error.

Parameters
string$form_nameForm namespace
Returns
void
Since
1.8.0

Definition at line 132 of file input.php.

elgg_clear_sticky_value (   $form_name,
  $variable 
)

Remove one value of form submission data from the session.

Parameters
string$form_nameThe name of the form
string$variableThe name of the variable to clear
Returns
void
Since
1.8.0

Definition at line 186 of file input.php.

elgg_get_request_data (   $filter_result = true)

Returns all values parsed from the current request, including $_GET and $_POST values, as well as any values set with set_input()

See also
get_input()
set_input()
Parameters
bool$filter_resultSanitize input values
Returns
array
Since
3.0

Definition at line 51 of file input.php.

elgg_get_sticky_value (   $form_name,
  $variable = '',
  $default = null,
  $filter_result = true 
)

Get a specific value from cached form submission data.

Parameters
string$form_nameThe name of the form
string$variableThe name of the variable
mixed$defaultDefault value if the variable does not exist in sticky cache
boolean$filter_resultFilter for bad input if true
Returns
mixed
Since
1.8.0

Definition at line 160 of file input.php.

elgg_get_sticky_values (   $form_name,
  $filter_result = true 
)

Get all submission data cached for a form.

Parameters
string$form_nameThe name of the form
bool$filter_resultFilter for bad input if true
Returns
array
Since
1.8.0

Definition at line 173 of file input.php.

elgg_get_title_input (   $variable = 'title',
  $default = '' 
)

Get an HTML-escaped title from input.

E.g. "How to use <b> tags"

Parameters
string$variableThe desired variable name
string$defaultThe default if none given
Returns
string
Since
3.0

Definition at line 64 of file input.php.

elgg_is_empty (   $value)

Check if a value isn't empty, but allow 0 and '0'.

Parameters
mixed$valuethe value to check
See also
empty()
Elgg::isEmpty()
Returns
bool
Since
3.0.0

Definition at line 201 of file input.php.

elgg_is_sticky_form (   $form_name)

Does form submission data exist for this form?

Parameters
string$form_nameForm namespace
Returns
boolean
Since
1.8.0

Definition at line 144 of file input.php.

elgg_make_sticky_form (   $form_name,
array  $ignored_field_names = [] 
)

Save form submission data (all GET and POST vars) into a session cache.

Call this from an action when you want all your submitted variables available if the submission fails validation and is sent back to the form

Parameters
string$form_nameName of the sticky form
string[]$ignored_field_names Field names which shouldn't be made sticky in this form
Returns
void
Since
1.8.0

Definition at line 116 of file input.php.

filter_tags (   $var)

Filter tags from a given string based on registered hooks.

Parameters
mixed$varAnything that does not include an object (strings, ints, arrays) This includes multi-dimensional arrays.
Returns
mixed The filtered result - everything will be strings

Definition at line 77 of file input.php.

get_input (   $variable,
  $default = null,
  $filter_result = true 
)

Parameter input functions.

This file contains functions for getting input from get/post variables. Get some input from variables passed submitted through GET or POST.

If using any data obtained from get_input() in a web page, please be aware that it is a possible vector for a reflected XSS attack. If you are expecting an integer, cast it to an int. If it is a string, escape quotes.

Parameters
string$variableThe variable name we want.
mixed$defaultA default value for the variable if it is not found.
bool$filter_resultIf true, then the result is filtered for bad tags.
Returns
mixed
Examples:
/root/Elgg/engine/lib/views.php.

Definition at line 20 of file input.php.

is_email_address (   $address)

Validates an email address.

Parameters
string$addressEmail address.
Returns
bool

Definition at line 100 of file input.php.

set_input (   $variable,
  $value 
)

Sets an input value that may later be retrieved by get_input.

Note: this function does not handle nested arrays (ex: form input of param[m][n])

Parameters
string$variableThe name of the variable
string|string[]$value The value of the variable
Returns
void

Definition at line 34 of file input.php.

string_to_tag_array (   $string)

Takes in a comma-separated string and returns an array of tags which have been trimmed.

Parameters
string$stringComma-separated tag string
Returns
mixed An array of strings or the original data if input was not a string

Definition at line 284 of file input.php.