PHP wrapper functions

Functions that are wrappers or custom implementations of PHP functions.

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

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

For ease of use and memorizing, all these wrapper functions use the same name as the original PHP function, but prefixed with "drupal_". 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.


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


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


Namesort ascending Location Description
php_eval modules/php/php.module Evaluates a string of PHP code.
drupal_xml_parser_create includes/ Prepare a new XML parser.
drupal_unlink includes/ Deletes a file.
drupal_ucfirst includes/ Capitalize the first letter of a UTF-8 string.
drupal_tempnam includes/ Creates a file with a unique filename in the specified directory.
drupal_substr includes/ Cut off a piece of a string based on character indices and counts. Follows the same behavior as PHP's own substr() function.
drupal_strtoupper includes/ Uppercase a UTF-8 string.
drupal_strtolower includes/ Lowercase a UTF-8 string.
drupal_strlen includes/ Count the amount of characters in a UTF-8 string. This is less than or equal to the byte count.
drupal_set_time_limit includes/ Attempts to set the PHP maximum execution time.
drupal_session_start includes/ Forcefully starts a session, preserving already set session data.
drupal_session_regenerate includes/ Called when an anonymous user becomes authenticated or vice-versa.
drupal_rmdir includes/ Removes a directory.
drupal_register_shutdown_function includes/ Registers a function for execution on shutdown.
drupal_realpath includes/ Returns the absolute local filesystem path of a stream URI.
drupal_parse_url includes/ Parses a system URL string into an associative array suitable for url().
drupal_move_uploaded_file includes/ Moves an uploaded file to a new location.
drupal_mkdir includes/ Creates a directory using Drupal's default mode.
drupal_json_encode includes/ Converts a PHP variable into its JavaScript equivalent.
drupal_json_decode includes/ Converts an HTML-safe JSON string into its PHP equivalent.
drupal_http_build_query includes/ Parses an array into a valid, rawurlencoded query string.
drupal_dirname includes/ Gets the name of the directory from a given path.
drupal_chmod includes/ Sets the permissions on a file or directory.
drupal_basename includes/ Gets the filename from a given path.


includes/, line 11
Common functions that many Drupal modules will need to reference.