Scroll to navigation

Mojolicious::Plugin(3pm) User Contributed Perl Documentation Mojolicious::Plugin(3pm)

NAME

Mojolicious::Plugin - Plugin base class

SYNOPSIS

  # CamelCase plugin name
  package Mojolicious::Plugin::MyPlugin;
  use Mojo::Base 'Mojolicious::Plugin';

  sub register {
    my ($self, $app, $conf) = @_;

    # Magic here! :)
  }

DESCRIPTION

Mojolicious::Plugin is an abstract base class for Mojolicious plugins.

See "PLUGINS" in Mojolicious::Plugins for a list of plugins that are available by default.

METHODS

Mojolicious::Plugin inherits all methods from Mojo::Base and implements the following new ones.

register

  $plugin->register(Mojolicious->new);
  $plugin->register(Mojolicious->new, {foo => 'bar'});

This method will be called by Mojolicious::Plugins at startup time. Meant to be overloaded in a subclass.

SEE ALSO

Mojolicious, Mojolicious::Guides, <https://mojolicious.org>.
2019-02-05 perl v5.28.1