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:

<?php

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

?>

Correct:

<?php

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

?>

End of "defgroup php_wrappers".

Functions

Name	Location	Description
drupal_chmod	includes/file.inc	Set the permissions on a file or directory.
drupal_dirname	includes/file.inc	Gets the name of the directory from a given path.
drupal_http_build_query	includes/common.inc	Parse an array into a valid, rawurlencoded query string.
drupal_mkdir	includes/file.inc	Creates a directory using Drupal's default mode.
drupal_parse_url	includes/common.inc	Wrapper around parse_url() to parse a system URL string into an associative array, suitable for url().
drupal_realpath	includes/file.inc	Returns the absolute path of a file or directory
drupal_session_regenerate	includes/session.inc	Called when an anonymous user becomes authenticated or vice-versa.
drupal_session_start	includes/session.inc	Forcefully start a session, preserving already set session data.
drupal_set_time_limit	includes/common.inc	Attempts to set the PHP maximum execution time.
drupal_strlen	includes/unicode.inc	Count the amount of characters in a UTF-8 string. This is less than or equal to the byte count.
drupal_strtolower	includes/unicode.inc	Lowercase a UTF-8 string.
drupal_strtoupper	includes/unicode.inc	Uppercase a UTF-8 string.
drupal_substr	includes/unicode.inc	Cut off a piece of a string based on character indices and counts. Follows the same behavior as PHP's own substr() function.
drupal_tempnam	includes/file.inc	Creates a file with a unique filename in the specified directory.
drupal_ucfirst	includes/unicode.inc	Capitalize the first letter of a UTF-8 string.
drupal_xml_parser_create	includes/unicode.inc	Prepare a new XML parser.
php_eval	modules/php/php.module	Evaluate a string of PHP code.

Login or register to post comments