Drupal 7 Tutorial: Using Entityqueue

Now that Entityqueue has been released, I wanted to give a quick tutorial on how to use it.

You can manage the queues from the /admin/structure/entityqueue page.

Click "Add" to create a new queue. Once you're there you have several options. Enter the queue title and optionally change the machine name. I'll talk more about the handler in a future blog post, but for most cases the "Simple queue" handler will be what you want.

Next you select the entity type for the queue. Then select which content types (aka: bundles) that can be added to this queue.

Under "Queue properties" you can set the minimum and maximum number of items allowed in the queue. If you want an unlimited max, leave 0 in the max items field. If you enter any other max, you have an option for what should happen when the max is reached. By default, when somebody tries to add another item to the queue, you get a validation error and another item will have to be removed before a new one is added. If you check the "Act as queue" box then the top-most item(s) will be automatically removed from the queue when the next item is added.

Hit "Save" and now you can see your new queue in the list.

Entityqueue uses Ctools, so you can Disable, Delete, Clone and Export your queues too!

When you click "Edit items" you are presented with an Entityreference autocomplete field to add new items. Click on the item and then hit "Add item"

The item now shows up in a draggable table that allows you to reorder items.

Once you have several items in the queue you can reorder them.

Click the "Remove" button next to an item to remove it.

Once you're all done adding, rearranging and removing items, hit "Save".