Elgg
Version 6.0
|
Go to the source code of this file.
Functions | |
elgg_format_html (string $html, array $options=[]) | |
Output functions Processing text for output such as pulling out URLs and extracting excerpts. More... | |
elgg_parse_urls (string $text) | |
Takes a string and turns any URLs into formatted links. More... | |
elgg_parse_emails (string $text) | |
Takes a string and turns any email addresses into formatted links. More... | |
elgg_parse_mentions (string $text) | |
Takes a string and turns any @ mentions into formatted links. More... | |
elgg_autop (string $string) | |
Create paragraphs from text with line spacing. More... | |
elgg_get_excerpt (string $text, int $num_chars=250) | |
Returns an excerpt. More... | |
elgg_format_bytes (int $size, int $precision=2) | |
Format bytes to a human readable format. More... | |
elgg_format_element (string $tag_name, array $attributes=[], string $text= '', array $options=[]) | |
Format an HTML element. More... | |
elgg_normalize_url (string $url) | |
elgg_normalize_site_url (string $unsafe_url) | |
From untrusted input, get a site URL safe for forwarding. More... | |
elgg_get_friendly_title (string $title) | |
When given a title, returns a version suitable for inclusion in a URL. More... | |
elgg_get_friendly_time (int $time, int $current_time=null) | |
Formats a UNIX timestamp in a friendly way (eg "less than a minute ago") More... | |
elgg_get_friendly_upload_error (int $error_code) | |
Returns a human-readable message for PHP's upload error codes. More... | |
elgg_strip_tags (string $string, string $allowable_tags=null) | |
Strip tags and offer plugins the chance. More... | |
elgg_html_decode (string $string) | |
Decode HTML markup into a raw text string. More... | |
_elgg_get_display_query (string $string) | |
Prepares query string for output to prevent CSRF attacks. More... | |
_elgg_get_display_query | ( | string | $string | ) |
Prepares query string for output to prevent CSRF attacks.
string | $string | string to prepare |
Definition at line 366 of file output.php.
elgg_autop | ( | string | $string | ) |
Create paragraphs from text with line spacing.
string | $string | The string |
Definition at line 67 of file output.php.
elgg_format_bytes | ( | int | $size, |
int | $precision = 2 |
||
) |
Format bytes to a human readable format.
int | $size | File size in bytes to format |
int | $precision | Precision to round formatting bytes to |
Definition at line 103 of file output.php.
elgg_format_element | ( | string | $tag_name, |
array | $attributes = [] , |
||
string | $text = '' , |
||
array | $options = [] |
||
) |
Format an HTML element.
string | $tag_name | The element tagName. e.g. "div". This will not be validated. |
array | $attributes | The element attributes. |
string | $text | The contents of the element. Assumed to be HTML unless encode_text is true. |
array | $options | Options array with keys:
|
Definition at line 145 of file output.php.
elgg_format_html | ( | string | $html, |
array | $options = [] |
||
) |
Output functions Processing text for output such as pulling out URLs and extracting excerpts.
Prepare HTML output
string | $html | HTML string |
array | $options | Formatting options |
bool $parse_urls Replace URLs with anchor tags bool $parse_emails Replace email addresses with anchor tags bool $sanitize Sanitize HTML tags bool $autop Add paragraphs instead of new lines
Definition at line 20 of file output.php.
elgg_get_excerpt | ( | string | $text, |
int | $num_chars = 250 |
||
) |
Returns an excerpt.
Will return up to n chars stopping at the nearest space. If no spaces are found (like in Japanese) will crop off at the n char mark. Adds ... if any text was chopped.
string | $text | The full text to excerpt |
int | $num_chars | Return a string up to $num_chars long |
Definition at line 83 of file output.php.
elgg_get_friendly_time | ( | int | $time, |
int | $current_time = null |
||
) |
Formats a UNIX timestamp in a friendly way (eg "less than a minute ago")
int | $time | A UNIX epoch timestamp |
int | $current_time | Current UNIX epoch timestamp (optional) |
Definition at line 221 of file output.php.
elgg_get_friendly_title | ( | string | $title | ) |
When given a title, returns a version suitable for inclusion in a URL.
string | $title | The title |
Definition at line 192 of file output.php.
elgg_get_friendly_upload_error | ( | int | $error_code | ) |
Returns a human-readable message for PHP's upload error codes.
int | $error_code | The code as stored in $_FILES['name']['error'] |
Definition at line 272 of file output.php.
elgg_html_decode | ( | string | $string | ) |
Decode HTML markup into a raw text string.
This applies html_entity_decode() to a string while re-entitising HTML special char entities to prevent them from being decoded back to their unsafe original forms.
This relies on html_entity_decode() not translating entities when doing so leaves behind another entity, e.g. > if decoded would create > which is another entity itself. This seems to escape the usual behaviour where any two paired entities creating a HTML tag are usually decoded, i.e. a lone > is not decoded, but <foo> would be decoded to <foo> since it creates a full tag.
Note: html_entity_decode() is poorly explained in the manual - which is really bad given its potential for misuse on user input already escaped elsewhere. Stackoverflow is littered with advice to use this function in the precise way that would lead to user input being capable of injecting arbitrary HTML.
string | $string | Encoded HTML |
Definition at line 354 of file output.php.
elgg_normalize_site_url | ( | string | $unsafe_url | ) |
From untrusted input, get a site URL safe for forwarding.
string | $unsafe_url | URL from untrusted input |
Definition at line 175 of file output.php.
elgg_normalize_url | ( | string | $url | ) |
Definition at line 163 of file output.php.
elgg_parse_emails | ( | string | $text | ) |
Takes a string and turns any email addresses into formatted links.
string | $text | The input string |
Definition at line 44 of file output.php.
elgg_parse_mentions | ( | string | $text | ) |
Takes a string and turns any @ mentions into formatted links.
string | $text | The input string |
Definition at line 56 of file output.php.
elgg_parse_urls | ( | string | $text | ) |
Takes a string and turns any URLs into formatted links.
string | $text | The input string |
Definition at line 32 of file output.php.
elgg_strip_tags | ( | string | $string, |
string | $allowable_tags = null |
||
) |
Strip tags and offer plugins the chance.
Plugins register for output:strip_tags event. Original string included in $params['original_string']
string | $string | Formatted string |
string | $allowable_tags | Optional parameter to specify tags which should not be stripped |
Definition at line 323 of file output.php.