function _update_message_text

Same name in other branches
  1. 9 core/modules/update/update.module \_update_message_text()
  2. 8.9.x core/modules/update/update.module \_update_message_text()
  3. 10 core/modules/update/update.module \_update_message_text()
  4. 11.x core/modules/update/update.module \_update_message_text()

Returns the appropriate message text when site is out of date or not secure.

These error messages are shared by both update_requirements() for the site-wide status report at admin/reports/status and in the body of the notification e-mail messages generated by update_cron().

Parameters

$msg_type: String to indicate what kind of message to generate. Can be either 'core' or 'contrib'.

$msg_reason: Integer constant specifying why message is generated.

$report_link: (optional) Boolean that controls if a link to the updates report should be added. Defaults to FALSE.

$language: (optional) A language object to use. Defaults to NULL.

Return value

The properly translated error message for the given key.

2 calls to _update_message_text()
update_mail in modules/update/update.module
Implements hook_mail().
_update_requirement_check in modules/update/update.install
Fills in the requirements array.

File

modules/update/update.module, line 566

Code

function _update_message_text($msg_type, $msg_reason, $report_link = FALSE, $language = NULL) {
    $langcode = isset($language) ? $language->language : NULL;
    $text = '';
    switch ($msg_reason) {
        case UPDATE_NOT_SECURE:
            if ($msg_type == 'core') {
                $text = t('There is a security update available for your version of Drupal. To ensure the security of your server, you should update immediately!', array(), array(
                    'langcode' => $langcode,
                ));
            }
            else {
                $text = t('There are security updates available for one or more of your modules or themes. To ensure the security of your server, you should update immediately!', array(), array(
                    'langcode' => $langcode,
                ));
            }
            break;
        case UPDATE_REVOKED:
            if ($msg_type == 'core') {
                $text = t('Your version of Drupal has been revoked and is no longer available for download. Upgrading is strongly recommended!', array(), array(
                    'langcode' => $langcode,
                ));
            }
            else {
                $text = t('The installed version of at least one of your modules or themes has been revoked and is no longer available for download. Upgrading or disabling is strongly recommended!', array(), array(
                    'langcode' => $langcode,
                ));
            }
            break;
        case UPDATE_NOT_SUPPORTED:
            if ($msg_type == 'core') {
                $text = t('Your version of Drupal is no longer supported. Upgrading is strongly recommended!', array(), array(
                    'langcode' => $langcode,
                ));
            }
            else {
                $text = t('The installed version of at least one of your modules or themes is no longer supported. Upgrading or disabling is strongly recommended. See the project homepage for more details.', array(), array(
                    'langcode' => $langcode,
                ));
            }
            break;
        case UPDATE_NOT_CURRENT:
            if ($msg_type == 'core') {
                $text = t('There are updates available for your version of Drupal. To ensure the proper functioning of your site, you should update as soon as possible.', array(), array(
                    'langcode' => $langcode,
                ));
            }
            else {
                $text = t('There are updates available for one or more of your modules or themes. To ensure the proper functioning of your site, you should update as soon as possible.', array(), array(
                    'langcode' => $langcode,
                ));
            }
            break;
        case UPDATE_UNKNOWN:
        case UPDATE_NOT_CHECKED:
        case UPDATE_NOT_FETCHED:
        case UPDATE_FETCH_PENDING:
            if ($msg_type == 'core') {
                $text = t('There was a problem checking <a href="@update-report">available updates</a> for Drupal.', array(
                    '@update-report' => url('admin/reports/updates'),
                ), array(
                    'langcode' => $langcode,
                ));
            }
            else {
                $text = t('There was a problem checking <a href="@update-report">available updates</a> for your modules or themes.', array(
                    '@update-report' => url('admin/reports/updates'),
                ), array(
                    'langcode' => $langcode,
                ));
            }
            break;
    }
    if ($report_link) {
        if (update_manager_access()) {
            $text .= ' ' . t('See the <a href="@available_updates">available updates</a> page for more information and to install your missing updates.', array(
                '@available_updates' => url('admin/reports/updates/update', array(
                    'language' => $language,
                )),
            ), array(
                'langcode' => $langcode,
            ));
        }
        else {
            $text .= ' ' . t('See the <a href="@available_updates">available updates</a> page for more information.', array(
                '@available_updates' => url('admin/reports/updates', array(
                    'language' => $language,
                )),
            ), array(
                'langcode' => $langcode,
            ));
        }
    }
    return $text;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.