You are here

Home » API reference » Wysiwyg 5 » wysiwyg.module

function wysiwyg_get_path in Wysiwyg 5

Same name and namespace in other branches
  1. 5.2 wysiwyg.module \wysiwyg_get_path()
  2. 6.2 wysiwyg.module \wysiwyg_get_path()
  3. 6 wysiwyg.module \wysiwyg_get_path()
  4. 7.2 wysiwyg.module \wysiwyg_get_path()

Helper function to build module/file paths.

Parameters

$file: A file or directory in a module to return.

$base_path: Whether to prefix the resulting path with base_path().

$module: The module name to use as prefix.

Return value

The path to the specified file in a module.

Related topics

Wysiwyg API
@todo Forked from Panels; abstract into a separate API module that allows contrib modules to define supported include/plugin types.
17 calls to wysiwyg_get_path()
wysiwyg_fckeditor_editor in editors/fckeditor.inc
Plugin implementation of hook_editor().
wysiwyg_fckeditor_settings in editors/fckeditor.inc
Return runtime editor settings for a given wysiwyg profile.
wysiwyg_get_all_editors in ./wysiwyg.module
Compile a list holding all supported editors including installed editor version information.
wysiwyg_jwysiwyg_editor in editors/jwysiwyg.inc
Plugin implementation of hook_editor().
wysiwyg_jwysiwyg_version in editors/jwysiwyg.inc
Detect editor version.

... See full list

File

./wysiwyg.module, line 678
Integrate client-side editors with Drupal.

Code

function wysiwyg_get_path($file = '', $base_path = FALSE, $module = 'wysiwyg') {
  $base_path = $base_path ? base_path() : '';
  return $base_path . drupal_get_path('module', $module) . '/' . $file;
}