You are here

function _password_policy_get_readme in Password Policy 7.2

Gets README.txt.

This code adapted from the Drupal module documentation guidelines.

Return value

string|false The contents of README.txt, or FALSE if they could not be loaded.

See also

https://www.drupal.org/docs/develop/documenting-your-project/module-docu...

1 call to _password_policy_get_readme()
_password_policy_get_help_output in ./password_policy.module
Gets help output for hook_help().

File

./password_policy.module, line 633
Enforces password policies.

Code

function _password_policy_get_readme() {
  $filepath = dirname(__FILE__) . '/README.txt';
  if (file_exists($filepath)) {
    $readme = file_get_contents($filepath);
  }
  else {
    $readme = FALSE;
  }
  return $readme;
}