Back to Hhvm

Heapgraph Dfs Edges

hphp/hack/manual/apis/Functions/HH/heapgraph_dfs_edges.md

latest1.0 KB
Original Source

:::info[Note] This is a point-in-time snapshot of the API documentation from January 2026. Going forward, we will not be maintaining a public copy of these references, and recommend users to refer to the built-in signature helpers available in the Hack LSP instead for complete and up-to-date information. :::

performs dfs over the heap graph, starting from the given edges

Hack
namespace HH;

function heapgraph_dfs_edges(
  resource $heapgraph,
  array<int> $roots,
  array<int> $skips,
  mixed $callback,
): void;

calls back on every new edge in the scan.

Parameters

  • resource $heapgraph - the resource obtained with heapgraph_create
  • array<int> $roots - edge indexes to start the scan from
  • array<int> $skips - edge indexes to consider as if they're not there
  • mixed $callback - function(array<string, mixed> $edge, array<string, mixed> $node): void {} See documentation for heapgraph_node() about the "node" array passed to $callback

Returns

  • void
<!-- HHAPIDOC -->