# Get hyperlinks

* Extension version `1.6.0` or later;
* Build with `--enable-reader`;

Returns every `<hyperlink>` element in the active worksheet, covering both external URLs and intra-workbook jumps.

## Methods

```php
getHyperlinks(): ?array
```

## Return value

An array of hyperlink entries, each with:

* `first_row` *(int)* — starting row (1-based);
* `first_col` *(int)* — starting column (1-based);
* `last_row` *(int)* — ending row;
* `last_col` *(int)* — ending column;
* `url` *(string|null)* — external URL, or `null`;
* `location` *(string|null)* — internal target, e.g. `Sheet2!A1`;
* `display` *(string|null)* — display text;
* `tooltip` *(string|null)* — hover tooltip.

Returns `null` when `openSheet()` has not been called.

## Example

```php
$config = ['path' => './tests'];
$excel  = new \Vtiful\Kernel\Excel($config);

$links = $excel->openFile('source.xlsx')
    ->openSheet()
    ->getHyperlinks();

print_r($links);
// Array
// (
//     [0] => Array
//         (
//             [first_row] => 1
//             [first_col] => 1
//             [last_row]  => 1
//             [last_col]  => 1
//             [url]       => https://www.php.net
//             [location]  =>
//             [display]   => PHP home
//             [tooltip]   => Click to visit
//         )
// )
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://xlswriter-docs.viest.me/english/reader/get-hyperlinks.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.