Attachment Taxonomies

FAQ

Note that all code samples below should be run before the init action hook and not earlier than the plugins_loaded (or muplugins_loaded if you use the plugin as a must-use plugin) hook.

How can I add more attachment taxonomies?

You can simply use the WordPress Core function register_taxonomy() and specify 'attachment' as the second parameter. As an alternative, you can create your own class for the taxonomy, extending the abstract Attachment_Taxonomy class provided by the plugin. Then you can add it using the method add_taxonomy( $taxonomy ) of the class Attachment_Taxonomies.

Example Code (adds an attachment taxonomy called „Location“):

<?php

final class Attachment_Location extends Attachment_Taxonomy {
    protected $slug = 'attachment_location';
    protected $labels = array(
        'name'              => __( 'Locations', 'textdomain' ),
        'singular_name'     => __( 'Location', 'textdomain' ),
        /* more labels here... */
    );
    protected $args = array(
        'hierarchical'      => true,
        'query_var'         => 'location',
        /* more arguments here... */
    );
}

add_action(
    'plugins_loaded',
    function() {
        Attachment_Taxonomies::instance()->add_taxonomy( new Attachment_Location() );
    }
);

How can I remove the default attachment taxonomies?

To remove one of the default attachment taxonomies you should call the method remove_taxonomy( $taxonomy_slug ) of the class Attachment_Taxonomies.

Example Code (removes the attachment taxonomy „Category“):

<?php

add_action(
    'plugins_loaded',
    function() {
        Attachment_Taxonomies::instance()->remove_taxonomy( 'attachment_category' );
    }
);

How can I use the regular post categories and post tags for attachments instead of the additional taxonomies ?

To accomplish that, first you need to remove the two taxonomies that the plugin adds (attachment_category and attachment_tag). See above for instructions on how to do that.

Then you can simply use the WordPress Core function register_taxonomy_for_object_type() and specify 'attachment' as the second parameter. As an alternative, you can create your own instance of the Attachment_Existing_Taxonomy class provided by the plugin. Then you can add it using the method add_taxonomy( $taxonomy ) of the class Attachment_Taxonomies, as seen in the example below.

Example Code (makes the regular category and tag taxonomies available for attachments):

<?php

add_action(
    'plugins_loaded',
    function() {
        Attachment_Taxonomies::instance()->add_taxonomy( new Attachment_Existing_Taxonomy( 'category' ) );
        Attachment_Taxonomies::instance()->add_taxonomy( new Attachment_Existing_Taxonomy( 'post_tag' ) );
    }
);

How do I use the enhanced version of the `[gallery]` shortcode?

The [gallery] shortcode can now be passed taxonomy attributes. They have to have the attachment taxonomy slug as the attribute name and a comma-separated list of term slugs or term IDs as value. You may also specify a new „limit“ attribute to limit the amount of images shown. This is especially recommended if the attachment taxonomy term you are querying for contains a lot of images. As of version 1.2.0, the plugin furthermore supports an optional „tax_relation“ attribute, which you can set to „AND“ in order to show only images that satisfy all of the taxonomy attributes provided on the shortcode.

Example Code (shows images with attachment categories 1 or 2 or attachment tag 5 with a limit of 20 images shown):

[gallery attachment_category="1,2" attachment_tag="5" limit="20"]

Example Code (shows images with attachment categories 1 or 2 and attachment tag 5):

[gallery attachment_category="1,2" attachment_tag="5" tax_relation="AND"]

Note that there is currently no UI in the backend for this, and the preview in the editor will not work properly. It will show up correctly in the frontend though.

Which filters are available in the plugin?

The plugin provides some filters to adjust taxonomy arguments and labels.

• attachment_taxonomy_args where first argument is the array of taxonomy arguments and the second argument is the taxonomy slug that these arguments apply to
• attachment_taxonomy_{$taxonomy_slug}_args where the only argument is the array of taxonomy arguments for the taxonomy defined by $taxonomy_slug
• attachment_taxonomy_labels where first argument is the array of taxonomy labels and the second argument is the taxonomy slug that these labels apply to
• attachment_taxonomy_{$taxonomy_slug}_labels where the only argument is the array of taxonomy labels for the taxonomy defined by $taxonomy_slug
• attachment_taxonomy_class_names where the only argument is the array of class names of the taxonomies to register by default

Where should I submit my support request?

For regular support requests, please use the wordpress.org support forums. If you have a technical issue with the plugin where you already have more insight on how to fix it, you can also open an issue on GitHub instead.

How can I contribute to the plugin?

If you have ideas to improve the plugin or to solve a bug, feel free to raise an issue or submit a pull request in the GitHub repository for the plugin. Please stick to the contributing guidelines.

You can also contribute to the plugin by translating it. Simply visit translate.wordpress.org to get started.