---
name: "Test2::Event::Plan"
section: "3perl"
platform: "linux"
package: "perl"
version: "5.44.0-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/Test2::Event::Plan/3perl"
---

# Test2::Event::Plan(3perl)

The event of a plan

## NAME

Test2::Event::Plan - The event of a plan

## DESCRIPTION

Plan events are fired off whenever a plan is declared, done testing is called, or a subtext completes.

## SYNOPSIS

```
    use Test2::API qw/context/;
    use Test2::Event::Plan;
    my $ctx = context();
    # Plan for 10 tests to run
    my $event = $ctx->plan(10);
    # Plan to skip all tests (will exit 0)
    $ctx->plan(0, skip_all => "These tests need to be skipped");
```

## ACCESSORS

- $num = $plan-\>max

  Get the number of expected tests

- $dir = $plan-\>directive

  Get the directive (such as TODO, skip\_all, or no\_plan).

- $reason = $plan-\>reason

  Get the reason for the directive.

## SOURCE

The source code repository for Test2 can be found at \<https://github.com/Test-More/test-more/\>.

## MAINTAINERS

- Chad Granum \<exodist@cpan.org\>

  ## AUTHORS

- Chad Granum \<exodist@cpan.org\>

  ## COPYRIGHT

Copyright Chad Granum \<exodist@cpan.org\>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See \<https://dev.perl.org/licenses/\>