ExpressionEngine Docs

Jump Menu

Add-ons can easily add custom items for the Jump Menu.

If you are working with an existing add-on, we recommend you start with Modernizing add-ons

Creating your add-on jump file.

Jumps are created via the CLI by using the make:jump command.

php eecli.php make:jump 
Let's create an add-on Jump File!
What add-on is the Jumps file being added to? (amazing_add_on, cron):  [amazing_add_on]
Building Add-on Jumps file now.
Jumps file successfully created! Please note: You may need to clear your browser cache before you can see the new jump menu items

Follow the prompts to add a jump file to your add-on. This will create a jump.amazing_add_on.php file in your add-on.

 ┣ jump.amazing_add_on.php
 ┗ ...

Please note, your jump file will contain of the following:

    use ExpressionEngine\Service\JumpMenu\AbstractJumpMenu;

    class [AddonName]_jump extends AbstractJumpMenu

        protected static $items = array(
          'commandArrayTitle' => array(
            'icon' => 'fa-file',
            'command' => 'few lowercase words to be fuzzy-matched in jump menu',
            'command_title' => 'Displayed <b>command title upon match from above</b>',
            'dynamic' => false,
            'requires_keyword' => false,
            'target' => 'See Below. Behavior changes based on dynamic element above'

To Add Jump Menu commands to your add-on, you simply add array elements to the $items array in the example generated

The array of a Jump Menu command is comprised of the following keys:

Style Note: We use bold, italics, and brackets to denote keywords and actions to the user and urge you to use keep your commands in line with this style: “Edit <b>Your Object</b> titled <i>[secondary keywords]</i>” “Edit Author titled [name]”

In addition to the required array elements above. There are also the following array element that is optional.

'permission' => 'ban_users'