1 backdrop_web_test_case.php protected BackdropWebTestCase::clickLink($label, $index = 0)

Follows a link by name.

Will click the first link found with this link text by default, or a later one if an index is given. Match is case sensitive with normalized space. The label is translated label.

If the link is discovered and clicked, the test passes. Fail otherwise.


$label: Text between the anchor tags.

$index: Link position counting from zero.

Return value

Page contents on success, or FALSE on failure.:


core/modules/simpletest/backdrop_web_test_case.php, line 2990


Test case for typical Backdrop tests.


protected function clickLink($label, $index = 0) {
  $url_before = $this->getUrl();
  $urls = $this->xpath('//a[normalize-space(text())=:label]', array(':label' => $label));
  if (isset($urls[$index])) {
    $url_target = $this->getAbsoluteUrl($urls[$index]['href']);
    $this->pass(t('Clicked link %label (@url_target) from @url_before', array('%label' => $label, '@url_target' => $url_target, '@url_before' => $url_before)), 'Browser');
    return $this->backdropGet($url_target);
  $this->fail(t('Link %label does not exist on @url_before', array('%label' => $label, '@url_before' => $url_before)), 'Browser');
  return FALSE;