Community Documentation

drupal_get_path

5 common.inc drupal_get_path($type, $name)
6 common.inc drupal_get_path($type, $name)
7 common.inc drupal_get_path($type, $name)
8 common.inc drupal_get_path($type, $name)

Returns the path to a system item (module, theme, etc.).

Parameters

$type: The type of the item (i.e. theme, theme_engine, module, profile).

$name: The name of the item for which the path is requested.

Return value

The path to the requested item.

▾ 164 functions call drupal_get_path()

AggregatorTestCase::getAtomSample in modules/aggregator/aggregator.test
AggregatorTestCase::getRSS091Sample in modules/aggregator/aggregator.test
aggregator_test_feed in modules/aggregator/tests/aggregator_test.module
Page callback. Generates a test feed and simulates last-modified and etags.
AJAXFrameworkTestCase::testLazyLoad in modules/simpletest/tests/ajax.test
Test that new JavaScript and CSS files added during an AJAX request are returned.
ajax_forms_test_lazy_load_form_submit in modules/simpletest/tests/ajax_forms_test.module
Form submit handler: Adds JavaScript and CSS that wasn't on the original form.
bartik_preprocess_maintenance_page in themes/bartik/template.php
Implements hook_preprocess_maintenance_page().
BasicMinimalUpdatePath::setUp in modules/simpletest/tests/upgrade/upgrade.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
BasicStandardUpdatePath::setUp in modules/simpletest/tests/upgrade/upgrade.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
BasicUpgradePath::setUp in modules/simpletest/tests/upgrade/upgrade.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
block_admin_configure in modules/block/block.admin.inc
Form constructor for the block configuration form.
block_admin_demo in modules/block/block.admin.inc
Menu callback for admin/structure/block/demo.
block_admin_display_form in modules/block/block.admin.inc
Form constructor for the main block administration form.
block_test_system_theme_info in modules/block/tests/block_test.module
Implements hook_system_theme_info().
CascadingStylesheetsTestCase::testAddCssFileWithQueryString in modules/simpletest/tests/common.test
Tests that the query string remains intact when adding CSS files that have query string parameters.
CascadingStylesheetsTestCase::testAddFile in modules/simpletest/tests/common.test
Tests adding a file stylesheet.
CascadingStylesheetsTestCase::testAlter in modules/simpletest/tests/common.test
Tests Locale module's CSS Alter to include RTL overrides.
CascadingStylesheetsTestCase::testRenderFile in modules/simpletest/tests/common.test
Tests rendering the stylesheets.
CascadingStylesheetsTestCase::testRenderOrder in modules/simpletest/tests/common.test
Test CSS ordering.
CascadingStylesheetsTestCase::testRenderOverride in modules/simpletest/tests/common.test
Test CSS override.
CascadingStylesheetsUnitTest::testLoadCssBasic in modules/simpletest/tests/common.test
Tests basic CSS loading with and without optimization via drupal_load_stylesheet().
color_get_info in modules/color/color.module
Retrieves the Color module information for a particular theme.
color_scheme_form in modules/color/color.module
Form constructor for the color configuration form for a particular theme.
color_scheme_form_submit in modules/color/color.module
Form submission handler for color_scheme_form().
CommentUpgradePathTestCase::setUp in modules/simpletest/tests/upgrade/upgrade.comment.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
comment_form_node_form_alter in modules/comment/comment.module
Implements hook_form_BASE_FORM_ID_alter().
comment_form_node_type_form_alter in modules/comment/comment.module
Implements hook_form_FORM_ID_alter().
common_test_js_and_css_querystring in modules/simpletest/tests/common_test.module
Adds a JavaScript file and a CSS file with a query string appended.
contextual_library in modules/contextual/contextual.module
Implements hook_library().
dashboard_admin in modules/dashboard/dashboard.module
Dashboard page callback.
dashboard_theme in modules/dashboard/dashboard.module
Implements hook_theme().
dblog_init in modules/dblog/dblog.module
Implements hook_init().
DisabledNodeTypeTestCase::setUp in modules/simpletest/tests/upgrade/upgrade.node.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
DrupalRenderTestCase::testDrupalRenderChildrenAttached in modules/simpletest/tests/common.test
Test #attached functionality in children elements.
DrupalWebTestCase::drupalGetTestFiles in modules/simpletest/drupal_web_test_case.php
Get a list files that can be used in tests.
drupal_get_filetransfer_info in includes/common.inc
Assembles the Drupal FileTransfer registry.
drupal_install_system in includes/install.inc
Callback to install the system module.
field_ui_display_overview_form in modules/field_ui/field_ui.admin.inc
Form constructor for the field display settings for a given view mode.
field_ui_field_overview_form in modules/field_ui/field_ui.admin.inc
Form constructor for the 'Manage fields' form of a bundle.
FileScanDirectoryTest::setUp in modules/simpletest/tests/file.test
Generates a random database prefix, runs the install scripts on the prefixed database and enable the specified modules. After installation many caches are flushed and the internal browser is setup so that the page requests will run on the new prefix.…
FileScanDirectoryTest::testOptionRecurse in modules/simpletest/tests/file.test
Check that the recurse option decends into subdirectories.
file_element_info in modules/file/file.module
Implements hook_element_info().
file_field_settings_form in modules/file/file.field.inc
Implements hook_field_settings_form().
file_icon_path in modules/file/file.module
Creates a path to the icon for a file object.
FilledMinimalUpdatePath::setUp in modules/simpletest/tests/upgrade/upgrade.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
FilledStandardUpdatePath::setUp in modules/simpletest/tests/upgrade/upgrade.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
FilterFormatUpgradePathTestCase::setUp in modules/simpletest/tests/upgrade/upgrade.filter.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
FilterUnitTestCase::testUrlFilterContent in modules/filter/filter.test
Tests URL filter on longer content.
filter_admin_format_form in modules/filter/filter.admin.inc
Generate a text format form.
filter_process_format in modules/filter/filter.module
Expands an element into a base element with text format selector attached.
form_test_menu in modules/simpletest/tests/form_test.module
Implements hook_menu().
ForumUpgradePathTestCase::setUp in modules/simpletest/tests/upgrade/upgrade.forum.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
HelpTestCase::testHelp in modules/help/help.test
Logs in users, creates dblog events, and tests dblog functionality.
help_main in modules/help/help.admin.inc
Menu callback; prints a page listing a glossary of Drupal terminology.
hook_css_alter in modules/system/system.api.php
Alter CSS files before they are output on the page.
hook_init in modules/system/system.api.php
Perform setup tasks for non-cached page requests.
hook_js_alter in modules/system/system.api.php
Perform necessary alterations to the JavaScript before it is presented on the page.
hook_language_negotiation_info in modules/locale/locale.api.php
Allow modules to define their own language providers.
hook_library in modules/system/system.api.php
Registers JavaScript/CSS libraries associated with a module.
hook_library_alter in modules/system/system.api.php
Alters the JavaScript/CSS library registry.
hook_overlay_child_initialize in modules/overlay/overlay.api.php
Allow modules to act when an overlay child window is initialized.
hook_overlay_parent_initialize in modules/overlay/overlay.api.php
Allow modules to act when an overlay parent window is initialized.
hook_system_theme_info in modules/system/system.api.php
Return additional themes provided by modules.
ImageToolkitGdTestCase::testManipulations in modules/simpletest/tests/image.test
Since PHP can't visually check that our images have been manipulated properly, build a list of expected color values for each of the corners and the expected height and widths for the final images.
image_effect_form in modules/image/image.admin.inc
Form builder; Form for adding and editing image effects.
image_field_widget_process in modules/image/image.field.inc
An element #process callback for the image_image field type.
image_style_form in modules/image/image.admin.inc
Form builder; Edit an image style name and effects order.
image_style_list in modules/image/image.admin.inc
Menu callback; Listing of all current image styles.
install_configure_form in includes/install.core.inc
Installation task; configure settings for the new site.
JavaScriptTestCase::testAddJsFileWithQueryString in modules/simpletest/tests/common.test
Tests that the query string remains intact when adding JavaScript files that have query string parameters.
JavaScriptTestCase::testAlter in modules/simpletest/tests/common.test
Test altering a JavaScript's weight via hook_js_alter().
LocaleJavascriptTranslationTest::testFileParsing in modules/locale/locale.test
LocaleUpgradePathTestCase::setUp in modules/simpletest/tests/upgrade/upgrade.locale.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
locale_block_view in modules/locale/locale.module
Implements hook_block_view().
locale_language_switcher_session in includes/locale.inc
Return the session language switcher block.
locale_library_alter in modules/locale/locale.module
Implement hook_library_alter().
locale_test_language_negotiation_info in modules/locale/tests/locale_test.module
Implements hook_language_negotiation_info().
locale_translate_seek_screen in modules/locale/locale.admin.inc
String search screen.
MenuUpgradePathTestCase::setUp in modules/simpletest/tests/upgrade/upgrade.menu.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
menu_form_node_form_alter in modules/menu/menu.module
Implements hook_form_BASE_FORM_ID_alter().
menu_form_node_type_form_alter in modules/menu/menu.module
Implements hook_form_FORM_ID_alter().
menu_overview_form in modules/menu/menu.admin.inc
Form for editing an entire menu tree at once.
ModuleUnitTest::testModuleList in modules/simpletest/tests/module.test
The basic functionality of module_list().
ModuleUpdater::canUpdate in modules/system/system.updater.inc
ModuleUpdater::getInstallDirectory in modules/system/system.updater.inc
Return the directory where a module should be installed.
ModuleUpdater::isInstalled in modules/system/system.updater.inc
Checks if the project is installed.
module_load_include in includes/module.inc
Load a module include file.
NodeBodyUpgradePathTestCase::setUp in modules/simpletest/tests/upgrade/upgrade.node.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
node_form in modules/node/node.pages.inc
Generate the node add/edit form array.
node_mass_update in modules/node/node.admin.inc
Make mass update of nodes, changing all nodes in the $nodes array to update them with the field values in $updates.
node_type_form in modules/node/content_types.inc
Form constructor for the node type editing form.
openid_user_identities in modules/openid/openid.pages.inc
Menu callback; Manage OpenID identities for the specified user.
overlay_library in modules/overlay/overlay.module
Implements hook_library().
ParseInfoFilesTestCase::testParseInfoFile in modules/simpletest/tests/common.test
Parse an example .info file an verify the results.
path_form_node_form_alter in modules/path/path.module
Implements hook_form_BASE_FORM_ID_alter().
php_eval in modules/php/php.module
Evaluates a string of PHP code.
PollUpgradePathTestCase::setUp in modules/simpletest/tests/upgrade/upgrade.poll.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
PollUpgradePathTestCase::setUp in modules/simpletest/tests/upgrade/upgrade.node.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
seven_css_alter in themes/seven/template.php
Implements hook_css_alter().
seven_tablesort_indicator in themes/seven/template.php
Override of theme_tablesort_indicator().
shortcut_preprocess_page in modules/shortcut/shortcut.module
Implements hook_preprocess_page().
shortcut_set_customize in modules/shortcut/shortcut.admin.inc
Form callback: builds the form for customizing shortcut sets.
shortcut_set_switch in modules/shortcut/shortcut.admin.inc
Form callback: builds the form for switching shortcut sets.
shortcut_toolbar_pre_render in modules/shortcut/shortcut.module
Pre-render function for adding shortcuts to the toolbar drawer.
SimpleTestFunctionalTest::testUserAgentValidation in modules/simpletest/simpletest.test
Test validation of the User-Agent header we use to perform test requests.
simpletest_js_alter in modules/simpletest/simpletest.module
Implements hook_js_alter().
simpletest_result_form in modules/simpletest/simpletest.pages.inc
Test results form for $test_id.
simpletest_run_tests in modules/simpletest/simpletest.module
Actually runs tests.
system_clean_url_settings in modules/system/system.admin.inc
Form builder; Configure clean URL settings.
system_configure_date_formats_form in modules/system/system.admin.inc
Allow users to add additional date formats.
system_image_toolkits in modules/system/system.module
Implements hook_image_toolkits().
system_init in modules/system/system.module
Implements hook_init().
system_modules_uninstall_confirm_form in modules/system/system.admin.inc
Confirm uninstall of selected modules.
system_performance_settings in modules/system/system.admin.inc
Form builder; Configure site performance settings.
system_test_authorize_init_page in modules/simpletest/tests/system_test.module
Page callback to initialize authorize.php during testing.
taxonomy_term_view in modules/taxonomy/taxonomy.module
Generate an array for rendering the given term.
text_field_widget_form in modules/field/modules/text/text.module
Implements hook_field_widget_form().
ThemeUpdater::canUpdate in modules/system/system.updater.inc
ThemeUpdater::getInstallDirectory in modules/system/system.updater.inc
Return the directory where a theme should be installed.
ThemeUpdater::isInstalled in modules/system/system.updater.inc
Checks if the project is installed.
theme_color_scheme_form in modules/color/color.module
Returns HTML for a theme's color form.
theme_dashboard in modules/dashboard/dashboard.module
Returns HTML for the entire dashboard.
theme_image_style_preview in modules/image/image.admin.inc
Returns HTML for a preview of an image style.
theme_profile_admin_overview in modules/profile/profile.admin.inc
Returns HTML for the profile field overview form into a drag and drop enabled table.
theme_simpletest_test_table in modules/simpletest/simpletest.pages.inc
Returns HTML for a test list generated by simpletest_test_form() into a table.
theme_taxonomy_overview_terms in modules/taxonomy/taxonomy.admin.inc
Returns HTML for a terms overview form as a sortable list of terms.
theme_test_system_theme_info in modules/simpletest/tests/theme_test.module
Implements hook_system_theme_info().
theme_update_report in modules/update/update.report.inc
Returns HTML for the project status report.
toolbar_theme in modules/toolbar/toolbar.module
Implements hook_theme().
toolbar_view in modules/toolbar/toolbar.module
Builds the admin menu as a structured array ready for drupal_render().
tracker_page in modules/tracker/tracker.pages.inc
Menu callback; prints a listing of active nodes on the site.
TranslatableUpgradePathTestCase::setUp in modules/simpletest/tests/upgrade/upgrade.translatable.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
UpdateTestUploadCase::testUploadModule in modules/update/update.test
Tests upload and extraction of a module.
update_access_allowed in ./update.php
Determines if the current user is allowed to run update.php.
update_authorize_run_install in modules/update/update.authorize.inc
Callback invoked by authorize.php to install a new project.
update_authorize_run_update in modules/update/update.authorize.inc
Callback invoked by authorize.php to update existing projects.
update_manager_install_form_submit in modules/update/update.manager.inc
Handle form submission when installing new projects via the update manager.
update_manager_update_form in modules/update/update.manager.inc
Build the form for the update manager page to update existing projects.
update_manager_update_form_submit in modules/update/update.manager.inc
Submit function for the main update form.
update_manager_update_ready_form_submit in modules/update/update.manager.inc
Submit handler for the form to confirm that an update should continue.
update_manual_status in modules/update/update.fetch.inc
Callback to manually check the update status without cron.
update_test_mock_page in modules/update/tests/update_test.module
Page callback, prints mock XML for the update module.
update_test_system_theme_info in modules/update/tests/update_test.module
Implements hook_system_theme_info().
UpgradePathTaxonomyTestCase::setUp in modules/simpletest/tests/upgrade/upgrade.taxonomy.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
UploadUpgradePathTestCase::setUp in modules/simpletest/tests/upgrade/upgrade.upload.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
UserUpgradePathNoPasswordTokenTestCase::setUp in modules/simpletest/tests/upgrade/upgrade.user.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
UserUpgradePathPasswordTokenTestCase::setUp in modules/simpletest/tests/upgrade/upgrade.user.test
Override of DrupalWebTestCase::setUp() specialized for upgrade testing.
user_admin_permissions in modules/user/user.admin.inc
Menu callback: administer permissions.
user_admin_settings in modules/user/user.admin.inc
Form builder; Configure user settings for this site.
user_form_field_ui_field_edit_form_alter in modules/user/user.module
Implements hook_form_FORM_ID_alter().
user_form_process_password_confirm in modules/user/user.module
Form element process handler for client-side password validation.
user_menu in modules/user/user.module
Implements hook_menu().
_aggregator_get_variables in modules/aggregator/aggregator.module
Gets the fetcher, parser, and processors.
_batch_test_batch_0 in modules/simpletest/tests/batch_test.module
Batch 0: no operation.
_batch_test_batch_1 in modules/simpletest/tests/batch_test.module
Batch 1: repeats a simple operation.
_batch_test_batch_2 in modules/simpletest/tests/batch_test.module
Batch 2: single multistep operation.
_batch_test_batch_3 in modules/simpletest/tests/batch_test.module
Batch 3: both single and multistep operations.
_batch_test_batch_4 in modules/simpletest/tests/batch_test.module
Batch 4: batch within a batch.
_batch_test_batch_5 in modules/simpletest/tests/batch_test.module
Batch 5: repeats a simple operation.
_book_add_form_elements in modules/book/book.module
Build the common elements of the book form for the node and outline forms.
_drupal_maintenance_theme in includes/theme.maintenance.inc
Sets up the theming system for maintenance page.
_locale_translate_language_list in includes/locale.inc
List languages in search result table
_menu_router_build in includes/menu.inc
Helper function to build the router table based on the data from hook_menu.
_openid_user_login_form_alter in modules/openid/openid.module
_theme_build_registry in includes/theme.inc
Build the theme registry cache.

File

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

Code

<?php
function drupal_get_path($type, $name) {
  return dirname(drupal_get_filename($type, $name));
}
?>

Comments

More information

  • It returns the path without slashes in front or after.
  • That's the type *first*, then the project name
    drupal_get_path('module', 'name_of_module');

    I reverse that enough (and then get confused as to why it isn't working) that i felt it worth documenting here, so the 'doh!' moment of realization comes sooner...

  • The valid types are as listed:
    • module
    • theme
    • profile
    • theme_engine

    I can't think of any others and i can't even think of a reason to use the last one.

link to types

link to all valid types or at least listing them would be nice.

Libraries?

Is there any way to properly get the path to a library?

Example:

<?php
drupal_add_js
(drupal_get_path('library', 'modernizr') . '/js/modernizr-1.6.min.js',
                            array(
'group' => JS_THEME, 'every_page' => TRUE));
?>

libraries module

Yes, there is a way. The function is in the libraries module.
Example:

<?php
drupal_add_js
(libraries_get_path('modernizr') . '/js/modernizr-1.6.min.js', array('group' => JS_THEME, 'every_page' => TRUE));
?>

Can you explain?

What does this parameter of the drupal_add_js function do?
array('group' => JS_THEME, 'every_page' => TRUE)

Simple

Documentation is located here.
http://api.drupal.org/api/drupal/includes--common.inc/function/drupal_ad...

Basically, the group is a weight level, with the javascript entries having their own weight below that particular group, and every_page denotes whether or not the js should be added to every page.

Login or register to post comments