MLAData \MLAData The _template functions are inspired by the book "WordPress 3 Plugin Development Essentials." Templates separate HTML markup from PHP code for easier maintenance and localization.

]]> $query_parameters This array defines parameters for the query's join, where and orderby filters. The parameters are set up in the _prepare_list_table_query function, and any further logic required to translate those values is contained in the filters.

]]> array $galleries This array contains all of the objects containing one or more [gallery] shortcodes and array(s) of which attachments each [gallery] contains. The arrays are built once each page load and cached for subsequent calls.

The outer array is keyed by post_id. It contains an array of [gallery] entries numbered from one (1). Each inner array has these elements: ['parent_title'] post_title of the gallery parent, ['parent_type'] 'post' or 'page' or the custom post_type of the gallery parent, ['query'] contains a string with the arguments of the [gallery], ['results'] contains an array of post_ids for the objects in the gallery.

]]> array $mla_galleries This array contains all of the objects containing one or more [mla_gallery] shortcodes and array(s) of which attachments each [mla_gallery] contains. The arrays are built once each page load and cached for subsequent calls.

]]> array initialize initialize mla_load_template mla_load_template Loads a template to a string or a multi-part template to an array. Multi-part templates are divided by comments of the form , where "key" becomes the key part of the array.

]]> string string string array false NULL $source $type mla_parse_template mla_parse_template A simple parsing function for basic templating.

]]> string array string $tpl $hash mla_count_list_table_items mla_count_list_table_items array integer $request mla_query_list_table_items mla_query_list_table_items Supports prepare_items in class-mla-list-table.php. Modeled after wp_edit_attachments_query in wp-admin/post.php

]]> array int int array $request $offset $count _prepare_list_table_query _prepare_list_table_query Prepare the arguments for WP_Query. Modeled after wp_edit_attachments_query in wp-admin/post.php

]]> array int int array $raw_request $offset $count _execute_list_table_query _execute_list_table_query array object $request mla_query_posts_search_filter mla_query_posts_search_filter Defined as public because it's a filter.

]]> string object string $search_string $query_object mla_query_posts_join_filter mla_query_posts_join_filter Defined as public because it's a filter.

]]> string string $join_clause mla_query_posts_where_filter mla_query_posts_where_filter Modeled after _edit_attachments_query_helper in wp-admin/post.php. Defined as public because it's a filter.

]]> string string $where_clause mla_query_posts_orderby_filter mla_query_posts_orderby_filter Expands the range of sort options because the logic in WP_Query is limited. Defined as public because it's a filter.

]]> string string $orderby_clause mla_get_attachment_by_id mla_get_attachment_by_id The (associative) array will contain every field that can be found in the posts and postmeta tables, and all references to the attachment.

]]> int NULL array $post_id mla_fetch_attachment_references mla_fetch_attachment_references Searches all post and page content to see if the attachment is used as a Featured Image or inserted in the post as an image or link.

]]> int int array $ID $parent _build_mla_galleries _build_mla_galleries array string boolean boolean $galleries_array $shortcode $exclude_revisions _search_mla_galleries _search_mla_galleries array int array $galleries_array $attachment_id _fetch_attachment_parent_data _fetch_attachment_parent_data int array $parent_id _fetch_attachment_metadata _fetch_attachment_metadata Returns a filtered array of a post's meta data. Internal values beginning with '' are stripped out or converted to an 'mla' equivalent. Array data is replaced with a string containing the first array element.

]]> int array $post_id \WP_List_Table MLA_List_Table \MLA_List_Table Extends the core WP_List_Table class.

]]> $rollover_id Set to the current Post-ID when row-level actions are output for the row.

]]> int $currently_hidden Records hidden columns so row-level actions are not assigned to them.

]]> array $default_columns '', 'icon' => '', 'ID_parent' => 'ID/Parent', 'title_name' => 'Title/Name', 'post_title' => 'Title', 'post_name' => 'Name', 'parent' => 'Parent ID', 'menu_order' => 'Menu Order', 'featured' => 'Featured in', 'inserted' => 'Inserted in', 'galleries' => 'Gallery in', 'mla_galleries' => 'MLA Gallery in', 'alt_text' => 'ALT Text', 'caption' => 'Caption', 'description' => 'Description', 'post_mime_type' => 'MIME Type', 'base_file' => 'Base File', 'date' => 'Date', 'modified' => 'Last Modified', 'author' => 'Author', 'attached_to' => 'Attached to')]]> This array defines table columns and titles where the key is the column slug (and class) and the value is the column's title text. If you need a checkbox for bulk actions, use the special slug "cb".

The 'cb' column is treated differently than the rest. If including a checkbox column in your table you must create a column_cb() method. If you don't need bulk actions or checkboxes, simply leave the 'cb' entry out of your array.

Taxonomy columns are added to this array by mla_admin_init_action.

]]> array $default_hidden_columns This array is used when the user-level option is not set, i.e., the user has not altered the selection of hidden columns.

The value on the right-hand side must match the column slug, e.g., array(0 => 'ID_parent, 1 => 'title_name').

Taxonomy columns are added to this array by mla_admin_init_action.

]]> array $default_sortable_columns array('ID', false), 'title_name' => array('title_name', false), 'post_title' => array('post_title', false), 'post_name' => array('post_name', false), 'parent' => array('post_parent', false), 'menu_order' => array('menu_order', false), 'alt_text' => array('_wp_attachment_image_alt', false), 'caption' => array('post_excerpt', false), 'description' => array('post_content', false), 'post_mime_type' => array('post_mime_type', false), 'base_file' => array('_wp_attached_file', false), 'date' => array('post_date', false), 'modified' => array('post_modified', false), 'author' => array('post_author', false), 'attached_to' => array('post_parent', false))]]> This array defines the table columns that can be sorted. The array key is the column slug that needs to be sortable, and the value is database column to sort by. Often, the key and value will be the same, but this is not always the case (as the value is a column name from the database, not the list table).

The array value also contains a boolean which is 'true' if the data is currently sorted by that column. This is computed each time the table is displayed.

]]> array _default_hidden_columns _default_hidden_columns array _avail_mime_types _avail_mime_types Modeled after get_available_post_mime_types in wp-admin/includes/post.php, with additional entries.

]]> array array $num_posts mla_get_attachment_mime_types mla_get_attachment_mime_types Modeled after get_post_mime_types in wp-admin/includes/post.php, with additional entries.

]]> array mla_get_sortable_columns mla_get_sortable_columns array mla_manage_hidden_columns_filter mla_manage_hidden_columns_filter Required because the screen.php get_hidden_columns function only uses the get_user_option result. Set when the file is loaded because the object is not created in time for the call from screen.php.

]]> string string object array $result $option $user_data mla_manage_columns_filter mla_manage_columns_filter This required filter dictates the table's columns and titles. Set when the file is loaded because the list_table object isn't created in time to affect the "screen options" setup.

]]> array mla_admin_init_action mla_admin_init_action Called in the admin_init action because the list_table object isn't created in time to affect the "screen options" setup.

]]> void __construct __construct void column_default column_default Called when the parent class can't find a method specifically built for a given column. The taxonomy columns are handled here. All other columns should have a specific method, so this function returns a troubleshooting message.

]]> array array string $item $column_name column_cb column_cb The 'cb' column is given special treatment when columns are processed.

]]> array string $item column_icon column_icon array string $item _build_rollover_actions _build_rollover_actions object string array $item $column _build_inline_data _build_inline_data object string $item column_ID_parent column_ID_parent array string $item column_title_name column_title_name array string $item column_post_title column_post_title array string $item column_post_name column_post_name array string $item column_parent column_parent array string $item column_menu_order column_menu_order array string $item column_featured column_featured array string $item column_inserted column_inserted array string $item column_galleries column_galleries array string $item column_mla_galleries column_mla_galleries array string $item column_alt_text column_alt_text array string $item column_caption column_caption array string $item column_description column_description array string $item column_post_mime_type column_post_mime_type array string $item column_base_file column_base_file array string $item column_date column_date array string $item column_modified column_modified array string $item column_author column_author array string $item column_attached_to column_attached_to array string $item get_columns get_columns array get_hidden_columns get_hidden_columns array get_sortable_columns get_sortable_columns Also notes the current sort column, if set.

]]> array get_views get_views These are listed across the top of the page and managed by WordPress.

]]> array get_bulk_actions get_bulk_actions option_title ) with the list of bulk actions available on this table.]]> array extra_tablenav extra_tablenav Modeled after class-wp-posts-list-table.php in wp-admin/includes.

]]> string array $which prepare_items prepare_items This is where you prepare your data for display. This method will usually be used to query the database, sort and filter the data, and generally get it ready to be displayed. At a minimum, we should set $this->items and $this->set_pagination_args().

]]> void single_row single_row object void $item MLA \MLA PLUGIN_NAME PLUGIN_NAME string CURRENT_MLA_VERSION CURRENT_MLA_VERSION string MIN_PHP_VERSION MIN_PHP_VERSION string MIN_WORDPRESS_VERSION MIN_WORDPRESS_VERSION string STYLESHEET_SLUG STYLESHEET_SLUG string JAVASCRIPT_SINGLE_EDIT_SLUG JAVASCRIPT_SINGLE_EDIT_SLUG string JAVASCRIPT_SINGLE_EDIT_OBJECT JAVASCRIPT_SINGLE_EDIT_OBJECT string JAVASCRIPT_INLINE_EDIT_SLUG JAVASCRIPT_INLINE_EDIT_SLUG string JAVASCRIPT_INLINE_EDIT_OBJECT JAVASCRIPT_INLINE_EDIT_OBJECT string ADMIN_PAGE_SLUG ADMIN_PAGE_SLUG string MLA_ADMIN_NONCE MLA_ADMIN_NONCE string MLA_ADMIN_SINGLE_DELETE MLA_ADMIN_SINGLE_DELETE string MLA_ADMIN_SINGLE_EDIT_DISPLAY MLA_ADMIN_SINGLE_EDIT_DISPLAY string MLA_ADMIN_SINGLE_EDIT_UPDATE MLA_ADMIN_SINGLE_EDIT_UPDATE string MLA_ADMIN_SINGLE_RESTORE MLA_ADMIN_SINGLE_RESTORE string MLA_ADMIN_SINGLE_TRASH MLA_ADMIN_SINGLE_TRASH string $page_hooks array initialize initialize This function contains add_action and add_filter calls to set up the Ajax handlers, enqueue JavaScript and CSS files, and set up the Assistant submenu.

]]> void mla_admin_init_action mla_admin_init_action void mla_admin_enqueue_scripts_action mla_admin_enqueue_scripts_action string void $page_hook mla_admin_menu_action mla_admin_menu_action Add a submenu page in the "Media" section, add settings page in the "Settings" section. add settings link in the Plugins section entry for MLA.

For WordPress versions before 3.5, add submenu page(s) for attachment taxonomies, add filter to clean up taxonomy submenu labels.

]]> void mla_load_upload_php_action mla_load_upload_php_action void mla_load_post_php_action mla_load_post_php_action void mla_add_menu_options mla_add_menu_options void mla_add_help_tab mla_add_help_tab void mla_screen_options_show_screen_filter mla_screen_options_show_screen_filter boolean string boolean $show_screen $this_screen mla_set_screen_option_filter mla_set_screen_option_filter boolean string string string void $status $option $value mla_edit_tax_redirect mla_edit_tax_redirect The custom taxonomy add/edit submenu entries go to "upload.php" by default. This filter is the only way to redirect them to the correct WordPress page. The filter is not required for WordPress 3.5 and later.

]]> void mla_parent_file_filter mla_parent_file_filter For WordPress before 3.5, the submenu entries for custom taxonomies under the "Media" menu are not set up correctly by WordPress, so this function cleans them up, redirecting the request to the right WordPress page for editing/adding taxonomy terms. For WordPress 3.5 and later, the function fixes the submenu bolding when going to the Edit Media screen.

]]> array string $parent_file mla_render_admin_page mla_render_admin_page void mla_inline_edit_action mla_inline_edit_action Adapted from wp_ajax_inline_save in /wp-admin/includes/ajax-actions.php

]]> void _build_inline_edit_form _build_inline_edit_form inspired by inline_edit() in wp-admin\includes\class-wp-posts-list-table.php.

]]> object string $MLAListTable _authors_dropdown _authors_dropdown integer string string string false $author $name $class _current_bulk_action _current_bulk_action string false _delete_single_item _delete_single_item array array $post_id _display_single_item _display_single_item int array $post_id _update_single_item _update_single_item int array array array array $post_id $new_data $tax_input $tax_actions _remove_tags _remove_tags array array object array $terms_before $tags $taxonomy_obj _restore_single_item _restore_single_item array array $post_id _trash_single_item _trash_single_item array array $post_id MLAObjects \MLAObjects initialize initialize void _build_taxonomies _build_taxonomies void mla_taxonomy_get_columns_filter mla_taxonomy_get_columns_filter array array $columns mla_taxonomy_column_filter mla_taxonomy_column_filter string array array array $place_holder $column_name $term_id MLASettings \MLASettings MLA_ALT_TEXT_VIEW_SUFFIX MLA_ALT_TEXT_VIEW_SUFFIX MLA_SETTINGS_SLUG MLA_SETTINGS_SLUG MLA_VERSION_OPTION MLA_VERSION_OPTION $mla_alt_text_view array $mla_options array('type' => 'hidden', 'std' => '0'), 'attachment_category' => array('name' => 'Attachment Categories', 'type' => 'hidden', 'std' => 'checked', 'help' => 'Check this option to add support for Attachment Categories.'), 'attachment_tag' => array('name' => 'Attachment Tags', 'type' => 'hidden', 'std' => 'checked', 'help' => 'Check this option to add support for Attachment Tags.'), 'where_used_heading' => array('name' => 'Where-used Reporting', 'type' => 'header'), 'exclude_revisions' => array('name' => 'Exclude Revisions', 'type' => 'checkbox', 'std' => 'checked', 'help' => 'Check this option to exclude revisions from where-used reporting.'), 'taxonomy_heading' => array('name' => 'Taxonomy Support', 'type' => 'header'), 'taxonomy_support' => array('help' => 'Check the "Support" box to add the taxonomy to the Assistant.
Check the "Inline Edit" box to display the taxonomy in the Quick Edit and Bulk Edit areas.
Use the "List Filter" option to select the taxonomy on which to filter the Assistant table listing.', 'std' => array('tax_support' => array('attachment_category' => 'checked', 'attachment_tag' => 'checked'), 'tax_quick_edit' => array('attachment_category' => 'checked', 'attachment_tag' => 'checked'), 'tax_filter' => 'attachment_category'), 'type' => 'custom', 'render' => '_taxonomy_handler', 'update' => '_taxonomy_handler', 'delete' => '_taxonomy_handler', 'reset' => '_taxonomy_handler'), 'orderby_heading' => array('name' => 'Default Table Listing Sort Order', 'type' => 'header'), 'default_orderby' => array('name' => 'Order By', 'type' => 'select', 'std' => 'title_name', 'options' => array('title_name'), 'texts' => array('Title/Name'), 'help' => 'Select the column for the sort order of the Assistant table listing.'), 'default_order' => array('name' => 'Order', 'type' => 'radio', 'std' => 'ASC', 'options' => array('ASC', 'DESC'), 'texts' => array('Ascending', 'Descending'), 'help' => 'Choose the sort order.'))]]> Each option is defined by an array with the following elements:

array key => HTML id/name attribute and option database key (OMIT MLA_OPTION_PREFIX)

name => admin page label or heading text type => 'checkbox', 'header', 'radio', 'select', 'text', 'textarea', 'custom', 'hidden' std => default value help => help text size => text size, default 40 cols => textbox columns, default 90 rows => textbox rows, default 5 options => array of radio or select option values texts => array of radio or select option display texts render => rendering function for 'custom' options. Usage: $options_list .= ['render']( 'render', $key, $value, $page_template_array ); update => update function for 'custom' options; returns nothing. Usage: $message = ['update']( 'update', $key, $value, $_REQUEST ); delete => delete function for 'custom' options; returns nothing. Usage: $message = ['delete']( 'delete', $key, $value, $_REQUEST ); reset => reset function for 'custom' options; returns nothing. Usage: $message = ['reset']( 'reset', $key, $value, $_REQUEST );

]]> initialize initialize void _version_upgrade _version_upgrade void _create_alt_text_view _create_alt_text_view This function is called on each plugin invocation because the plugin upgrade process does not call the activation hook.

]]> void mla_activation_hook mla_activation_hook Adds a view to the database to support sorting the listing on 'ALT Text'.

]]> void mla_deactivation_hook mla_deactivation_hook Removes a view from the database that supports sorting the listing on 'ALT Text'.

]]> void mla_admin_menu_action mla_admin_menu_action void mla_add_plugin_settings_link mla_add_plugin_settings_link array string array $links $file mla_get_option mla_get_option string mixed $option mla_update_option mla_update_option string mixed boolean $option $newvalue mla_delete_option mla_delete_option string boolean $option mla_render_settings_page mla_render_settings_page void mla_taxonomy_support mla_taxonomy_support string string boolean string $tax_name $support_type _save_settings _save_settings array array $template_array _reset_settings _reset_settings array array $template_array _taxonomy_handler _taxonomy_handler string string array array string $action $key $value $args MLAShortcodes \MLAShortcodes $mla_debug_messages string $mla_debug boolean initialize initialize void mla_attachment_list_shortcode mla_attachment_list_shortcode void mla_gallery_shortcode mla_gallery_shortcode This is a superset of the WordPress Gallery shortcode for displaying images on a post, page or custom post type. It is adapted from /wp-includes/media.php gallery_shortcode. Enhancements include many additional selection parameters and full taxonomy support.

]]> array string $attr mla_get_shortcode_attachments mla_get_shortcode_attachments int array array $post_parent $attr mla_shortcode_query_posts_where_filter mla_shortcode_query_posts_where_filter Captures debug information. Adds whitespace to the post_type = 'attachment' phrase to circumvent subsequent Role Scoper modification of the clause. Defined as public because it's a filter.

]]> string string $where_clause Defines constants and loads all of the classes and functions required to run the plugin. This file is only loaded if the naming conflict tests in index.php are passed.

]]> MLA_OPTION_PREFIX \MLA_OPTION_PREFIX This file contains several tests for name conflicts with other plugins. Only if the tests are passed will the rest of the plugin be loaded and run.

]]> includes/mla-plugin-loader.php MLA_PLUGIN_PATH \MLA_PLUGIN_PATH MLA_PLUGIN_URL \MLA_PLUGIN_URL mla_name_conflict_reporting_action \mla_name_conflict_reporting_action MLATest \MLATest $wordpress_3point5_plus boolean initialize initialize void min_php_version min_php_version string string void $min_version $plugin_name min_WordPress_version min_WordPress_version string string void $min_version $plugin_name todo fixme