Functions that are wrappers or custom implementations of PHP functions.

Certain PHP functions should not be used in Backdrop. Instead, Backdrop's replacement functions should be used.

For example, for improved or more secure UTF8-handling, or RFC-compliant handling of URLs in Backdrop.

For ease of use and memorizing, all these wrapper functions use the same name as the original PHP function, but prefixed with "backdrop_". Beware, however, that not all wrapper functions support the same arguments as the original functions.

You should always use these wrapper functions in your code.

Wrong:

  $my_substring = substr($original_string, 0, 5);

Correct:

  $my_substring = backdrop_substr($original_string, 0, 5);

File

includes/common.inc, line 10
Common functions that many Backdrop modules will need to reference.

Functions

Namesort descending Location Description
backdrop_basename includes/file.inc Gets the filename from a given path.
backdrop_chmod includes/file.inc Sets the permissions on a file or directory.
backdrop_dirname includes/file.inc Gets the name of the directory from a given path.
backdrop_http_build_query includes/common.inc Parses an array into a valid, rawurlencoded query string.
backdrop_json_decode includes/common.inc Converts an HTML-safe JSON string into its PHP equivalent.
backdrop_json_encode includes/common.inc Converts a PHP variable into its JavaScript equivalent.
backdrop_mkdir includes/file.inc Creates a directory using Backdrop's default mode.
backdrop_move_uploaded_file includes/file.inc Moves an uploaded file to a new location.
backdrop_parse_url includes/common.inc Parses a system URL string into an associative array suitable for url().
backdrop_realpath includes/file.inc Resolves the absolute filepath of a local URI or filepath.
backdrop_register_shutdown_function includes/bootstrap.inc Registers a function for execution on shutdown.
backdrop_rmdir includes/file.inc Removes a directory.
backdrop_session_regenerate includes/session.inc Called when an anonymous user becomes authenticated or vice-versa.
backdrop_session_start includes/session.inc Starts a session forcefully, preserving already set session data.
backdrop_set_time_limit includes/common.inc Attempts to set the PHP maximum execution time.
backdrop_strlen includes/unicode.inc Counts the number of characters in a UTF-8 string.
backdrop_strtolower includes/unicode.inc Lowercase a UTF-8 string.
backdrop_strtoupper includes/unicode.inc Uppercase a UTF-8 string.
backdrop_substr includes/unicode.inc Cuts off a piece of a string based on character indices and counts.
backdrop_tempnam includes/file.inc Creates a file with a unique filename in the specified directory.
backdrop_ucfirst includes/unicode.inc Capitalizes the first letter of a UTF-8 string.
backdrop_unlink includes/file.inc Deletes a file.
backdrop_xml_parser_create includes/unicode.inc Prepares a new XML parser.