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.

Wrong:

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

Correct:

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

Functions & methods

NameLocationDescription
drupal_basenameincludes/file.incGets the filename from a given path.
drupal_chmodincludes/file.incSets the permissions on a file or directory.
drupal_dirnameincludes/file.incGets the name of the directory from a given path.
drupal_http_build_queryincludes/common.incParses an array into a valid, rawurlencoded query string.
drupal_json_decodeincludes/common.incConverts an HTML-safe JSON string into its PHP equivalent.
drupal_json_encodeincludes/common.incConverts a PHP variable into its JavaScript equivalent.
drupal_mkdirincludes/file.incCreates a directory using Drupal's default mode.
drupal_move_uploaded_fileincludes/file.incMoves an uploaded file to a new location.
drupal_parse_urlincludes/common.incParses a system URL string into an associative array suitable for url().
drupal_realpathincludes/file.incReturns the absolute local filesystem path of a stream URI.
drupal_register_shutdown_functionincludes/bootstrap.incRegisters a function for execution on shutdown.
drupal_rmdirincludes/file.incRemoves a directory.
drupal_session_regenerateincludes/session.incCalled when an anonymous user becomes authenticated or vice-versa.
drupal_session_startincludes/session.incForcefully starts a session, preserving already set session data.
drupal_set_time_limitincludes/common.incAttempts to set the PHP maximum execution time.
drupal_strlenincludes/unicode.incCount the amount of characters in a UTF-8 string. This is less than or equal to the byte count.
drupal_strtolowerincludes/unicode.incLowercase a UTF-8 string.
drupal_strtoupperincludes/unicode.incUppercase a UTF-8 string.
drupal_substrincludes/unicode.incCut off a piece of a string based on character indices and counts. Follows the same behavior as PHP's own substr() function.
drupal_tempnamincludes/file.incCreates a file with a unique filename in the specified directory.
drupal_ucfirstincludes/unicode.incCapitalize the first letter of a UTF-8 string.
drupal_unlinkincludes/file.incDeletes a file.
drupal_xml_parser_createincludes/unicode.incPrepare a new XML parser.
php_evalmodules/php/php.moduleEvaluates a string of PHP code.

File

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