masonitedoors / widen-media

Search & add Widen digital assets to your WordPress Media Library.

Widen Media

Search and add Widen digital assets to your WordPress media library.

This WordPress plugin lets users search for images in Widen and add them to their site's media library. This plugin does not download media from Widen but rather creates a new WordPress media attachment that refers to the Widen asset URL. Some additional Widen metadata is captured and saved to the database on the "Add to Media Library" action. This plugin does not currently support syncing of meta data between Widen & WordPress.

Installation

You can either download a release zip and install via the WordPress plugin installer or via composer.

Composer

composer require masonitedoors/widen-media

Configuration

WordPress

This plugin uses V2 of the Widen API. You will need to define your Widen API access token in wp-config.php.

define( 'WIDEN_MEDIA_ACCESS_TOKEN', 'my-widen-api-token' );

Widen Metadata

Some additional Widen metadata is captured and saved to the database on the Add to Media Library action. This plugin does not currently support syncing of meta data between Widen & WordPress.

Collections

This plugin saves Widen collections under the post type wm_collection in order to provide a way for other themes and plugins to have access to this data without having to directly interact with Widen's API.

Within the main search page under "Add New", users can toggle "collection" when searching Widen. This will return only results that match that collection name.

When searching for a collection, a Save Collection button will be displayed. This button saves the current result page's collection to the metadata of a new post under the wp_collection post type. Note that a collection large than 100 assets will only save the 100 assets on the current results page.

Defining Custom Image Sizes

This plugin ships with some default image sizes however a filter has been included if you wish to change those defined sizes from within another plugin or theme.

Example function defining 2 image sizes:

function filter_defined_image_sizes( $default_image_sizes ) {
  $sizes = [
    'banner-sm' => [
      'label'  => __( 'Small Banner', 'textdomain' ),
      'width'  => 820,
      'height' => 312,
    ],
    'banner-lg' => [
      'label'  => __( 'Large Banner', 'textdomain' ),
      'width'  => 1500,
      'height' => 500,
    ],
  ];

  // Uncomment to append sizes to the plugin's already defined sizes.
  // $sizes = array_merge( $sizes, $default_image_sizes );

  return $sizes;
}
add_filter( 'wm_defined_image_sizes', 'filter_defined_image_sizes', 10, 1 );

Plugin API

This plugin provides some function to allow other plugins to easly interact with Widen data imported into WordPress as well as the Widen API.

wm_get_collections()

Returns an array of collection objects.

wm_get_collection( int $collection_id )

Returns the collection object.

wm_get_asset_fields( int $asset_id )

Returns all the fields from Widen for an asset that exists within the WordPress Media Library.

wm_get_asset_field( int $asset_id, string $key, bool $single = false )

Returns a single field for a Widen asset that exists within the WordPress Media Library.

widen-media's Issues

Add unit tests

Add pagination to bottom of search results.

#3 added helpful pagination to the search results. Pagination added to the bottom of the page would be amazing so that a user doesn't have to scroll all the way back up to the top of the results each time.

Allow user to sync meta data from Widen

Currently once an asset is added there is no way to automatically update the asset's metadata within WordPress with any changes from Widen.

This should be a button somewhere within wp-admin to initiate this action

We can also create a widen-media WP-CLI command to allow for metadata syncs programatically.

Add setting to only allow widen assets to be added to the media library

WordPress natively allows users to add/upload files to the media library. This proposed setting would disable that functionality and only allow widen assets via this plugin to be added.

Cannot add a new page to a menu when plugin is active

In the menu screen of wp-admin, when this plugin is active, a 500 error can be seen when attempting to add a new page to a menu.

<br><b>Uncaught Error</b>: Cannot use object of type WP_Error as array in <b>/opt/masonite-wp/var/www/html/wordpress/wp-content/plugins/widen-media/lib/Admin.php</b> on line <b>974</b><br><ul><li>save_post_collection_cb()<br><span class=“qm-info qm-supplemental”>wp-includes/class-wp-hook.php:289</span></li><li>apply_filters()<br><span class=“qm-info qm-supplemental”>wp-includes/class-wp-hook.php:311</span></li><li>do_action()<br><span class=“qm-info qm-supplemental”>wp-includes/plugin.php:478</span></li><li>do_action()<br><span class=“qm-info qm-supplemental”>wp-includes/post.php:4153</span></li><li>wp_insert_post()<br><span class=“qm-info qm-supplemental”>wp-includes/nav-menu.php:521</span></li><li>wp_update_nav_menu_item()<br><span class=“qm-info qm-supplemental”>wp-admin/includes/nav-menu.php:961</span></li><li>wp_save_nav_menu_items()<br><span class=“qm-info qm-supplemental”>wp-admin/includes/ajax-actions.php:1491</span></li><li>wp_ajax_add_menu_item()<br><span class=“qm-info qm-supplemental”>wp-includes/class-wp-hook.php:287</span></li><li>apply_filters()<br><span class=“qm-info qm-supplemental”>wp-includes/class-wp-hook.php:311</span></li><li>do_action()<br><span class=“qm-info qm-supplemental”>wp-includes/plugin.php:478</span></li><li>do_action()<br><span class=“qm-info qm-supplemental”>wp-admin/admin-ajax.php:175</span></li></ul><p>There has been a critical error on your website.</p><p><a href=“https://wordpress.org/support/article/debugging-in-wordpress/”>Learn more about debugging in WordPress.</a></p>

Move widen media settings to be under WP the core media settings

Add pagination to search results

We need pagination within the search results as it currently caps out at 100 (the request limit).

Total amount of results for that search should also be displayed.

Prevent the same asset from being added twice

Add filter for search

A great feature for this would be to filter what a based on file type or category of files to see. An example of this would be to display only images or only documents. Also, filters could be added for showing only .pdf or .png. This would rely on #21 for the document support before it would be feasible.

Display recent searches for a user

Notes

This data should be stored within the site's database utilizing update_user_meta().

Lazy load images in results

Support Document File Types

It would be great for the plugin to be able to support document file types (e.g. .pdf, .docx .txt) and allow for them to be uploaded to Wordpress from Widen.

Add a way to store Widen collections within the WordPress database

Notes

• The search_assets method is already setup to search a collection via the $collection argument. See https://github.com/masonitedoors/widen-media/blob/master/lib/Widen.php#L40
• We will only need one button to "Add Collection To Media Library" rather than an add button within each tile.
• We will need to register a new hidden custom post type to store these collections.

cc @ipetty14