Trouble loading custom element action (menu option)

Question

How do you load a custom element action using getAvailableActions inside my Element Type class?

public function getAvailableActions($source = null)
{
    $customAction = craft()->elements->getAction('Custom');

    $customAction->setParams(array(
        'label' => Craft::t('Custom'),
    ));

    $actions[] = $customAction;
}

The above renders a PHP error PHP Fatal error: Call to a member function setParams() on a non-object

PluginName_CustomElementAction is my file inside the elementactions folder, inside my plugin. Which is copied directly from https://craftcms.com/docs/plugins/element-actions

Here's what it looks like:

namespace Craft;
class PluginName_CustomElementAction extends BaseElementAction
{
    public function getName()
    {
        return Craft::t('Custom');
    }

    public function isDestructive()
    {
        return true;
    }

    public function performAction(ElementCriteriaModel $criteria)
    {
        // Remove all the ingredients from the selected elements
        $elements = $criteria->find();

        foreach ($elements as $element)
        {
            craft()->cocktailRecipes->removeAllIngredientsFromElement($element);
        }

        // Success!
        $this->setMessage(Craft::t('Ingredients removed successfully.'));
        return true;
    }
}

What is wrong with my getAvailableActions object?

Answer 1

I think your issue may be that the ElementsService getAction method expects the full classname for your custom ElementAction (sans the "ElementAction" suffix), i.e.

$customAction = craft()->elements->getAction('PluginName_Custom');

Answer 2

I'd recommend to follow the guide in the docs. https://craftcms.com/docs/plugins/element-actions

Update: There's a dedicated section about "Adding actions to index pages".

If your Element Action is intended for your own custom Element Type, you can do that by implementing the getAvailableActions() method on your Element Type class.

The link takes you to the method's documentation.

/**
 * Returns the available element actions for a given source (if one is provided).
 *
 * The actions can either be represented by their class handle (e.g. 'SetStatus'), or by an
 * instance.
 *
 * @param string|null $source The selected source’s key, if any.
 *
 * @return array|null The available element actions.
 */
public function getAvailableActions($source = null);

It's also explained how to implement actions for Craft’s built-in Element Types.

[…] Craft’s built-in Element Types: addEntryActions, addCategoryActions, …

There's example code provided if you click those links.

public function addEntryActions($source)
{
    return array(
        'Foo',
        new BarElementAction(),
    );
}