$mla_debug
$mla_debug : boolean
Turn debug collection and display on or off
Class MLA (Media Library Assistant) Shortcode Support provides the functions that implement the [mla_gallery] and [mla_tag_cloud] shortcodes. It also implements the mla_get_shortcode_attachments() and mla_get_terms() database access functions.
$query_parameters : array
WP_Query filter "parameters"
This array defines parameters for the query's join, where and orderby filters. The parameters are set up in the mla_get_shortcode_attachments function, and any further logic required to translate those values is contained in the filter.
Array index values are: orderby, post_parent
mla_gallery_shortcode(array $attr, string $content = NULL) : string
The 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 | $attr | Attributes of the shortcode |
string | $content | Optional content for enclosing shortcodes; used with mla_alt_shortcode |
HTML content to display gallery.
mla_tag_cloud(array $attr) : string
The MLA Tag Cloud support function.
This is an alternative to the WordPress wp_tag_cloud function, with additional options to customize the hyperlink behind each term.
array | $attr | Attributes of the shortcode. |
HTML content to display the tag cloud.
mla_tag_cloud_shortcode(array $attr, string $content = NULL) : string
The MLA Tag Cloud shortcode.
This is an interface to the mla_tag_cloud function.
array | $attr | Attributes of the shortcode. |
string | $content | Optional content for enclosing shortcodes |
HTML content to display the tag cloud.
_compose_term_list(string $list, array $links, array $terms, array $markup_values, array $arguments, array $attr) : void
Compose one level of an mla_term_list
Adds shortcode output text and term-specific links to arrays passed by reference.
string | $list | Shortcode output text, by reference |
array | $links | Term-specific links for flat/array output, by reference |
array | $terms | Term objects, by reference |
array | $markup_values | Style and list-level substitution parameters, by reference |
array | $arguments | Shortcode parameters, including defaults, by reference |
array | $attr | Shortcode parameters, explicit, by reference |
mla_term_list(array $attr) : string
The MLA Term List support function.
This is an alternative to the WordPress wp_list_categories, wp_dropdown_categories and wp_terms_checklist functions, with additional options to customize the hyperlink behind each term.
array | $attr | Attributes of the shortcode. |
HTML content to display the term list, dropdown control or checklist.
mla_term_list_shortcode(array $attr, string $content = NULL) : string
The MLA Term List shortcode.
This is an interface to the mla_term_list function.
array | $attr | Attributes of the shortcode. |
string | $content | Optional content for enclosing shortcodes |
HTML content to display the term list.
mla_shortcode_query_posts_where_filter( $where_clause) : string
Filters the WHERE clause for shortcode queries
Captures debug information. Adds whitespace to the post_type = 'attachment' phrase to circumvent subsequent Role Scoper modification of the clause. Handles post_parent "any" and "none" cases. Defined as public because it's a filter.
$where_clause |
query clause after modification
mla_shortcode_query_posts_orderby_filter( $orderby_clause) : string
Filters the ORDERBY clause for shortcode queries
This is an enhanced version of the code found in wp-includes/query.php, function get_posts. Defined as public because it's a filter.
$orderby_clause |
query clause after modification
mla_shortcode_query_posts_clauses_filter( $pieces) : array
Filters all clauses for shortcode queries, pre caching plugins
This is for debug purposes only. Defined as public because it's a filter.
$pieces |
query clauses after modification (none)
mla_shortcode_query_posts_clauses_request_filter( $pieces) : array
Filters all clauses for shortcode queries, post caching plugins
This is for debug purposes only. Defined as public because it's a filter.
$pieces |
query clauses after modification (none)
mla_get_terms( $attr) : array
Retrieve the terms in one or more taxonomies.
Alternative to WordPress /wp-includes/taxonomy.php function get_terms() that provides an accurate count of attachments associated with each term.
taxonomy - string containing one or more (comma-delimited) taxonomy names or an array of taxonomy names. Default 'post_tag'.
post_mime_type - MIME type(s) of the items to include in the term-specific counts. Default 'all'.
post_type - The post type(s) of the items to include in the term-specific counts. The default is "attachment".
post_status - The post status value(s) of the items to include in the term-specific counts. The default is "inherit".
ids - A comma-separated list of attachment ID values for an item-specific cloud.
include - An array, comma- or space-delimited string of term ids to include in the return array.
exclude - An array, comma- or space-delimited string of term ids to exclude from the return array. If 'include' is non-empty, 'exclude' is ignored.
parent - term_id of the terms' immediate parent; 0 for top-level terms.
minimum - minimum number of attachments a term must have to be included. Default 0.
no_count - 'true', 'false' (default) to suppress term-specific attachment-counting process.
number - maximum number of term objects to return. Terms are ordered by count, descending and then by term_id before this value is applied. Default 0.
orderby - 'count', 'id', 'name' (default), 'none', 'random', 'slug'
order - 'ASC' (default), 'DESC'
no_orderby - 'true', 'false' (default) to suppress ALL sorting clauses else false.
preserve_case - 'true', 'false' (default) to make orderby case-sensitive.
pad_counts - 'true', 'false' (default) to to include the count of all children in their parents' count.
limit - final number of term objects to return, for pagination. Default 0.
offset - number of term objects to skip, for pagination. Default 0.
fields - string with fields for the SQL SELECT clause, e.g.,
't.term_id, t.name, t.slug, COUNT(p.ID) AS count
'
$attr |
array of term objects, empty if none found
_validate_attributes(mixed $attr, string $content = NULL) : array
Make sure $attr is an array, repair line-break damage, merge with $content
mixed | $attr | Array or string containing shortcode attributes |
string | $content | Optional content for enclosing shortcodes; might be used with mla_alt_shortcode |
clean attributes array
_paginate_links( $output_parameters, $markup_values, $arguments, $found_rows, $output = '') : mixed
Handles pagnation output types 'previous_page', 'next_page', and 'paginate_links'
$output_parameters | ||
$markup_values | ||
$arguments | ||
$found_rows | ||
$output |
false or string with HTML for pagination output types
_process_pagination_output_types( $output_parameters, $markup_values, $arguments, $attr, $found_rows, $output = '') : mixed
Handles pagnation output types 'previous_page', 'next_page', and 'paginate_links'
$output_parameters | ||
$markup_values | ||
$arguments | ||
$attr | ||
$found_rows | ||
$output |
false or string with HTML for pagination output types
_validate_sql_orderby( $query_parameters, $table_prefix = NULL, $allowed_keys = NULL, $binary_keys = array()) : string|boolean
Translates query parameters to a valid SQL order by clause.
Accepts one or more valid columns, with or without ASC/DESC. Enhanced version of /wp-includes/formatting.php function sanitize_sql_orderby().
$query_parameters | ||
$table_prefix | ||
$allowed_keys | ||
$binary_keys |
Returns the orderby clause if present, false otherwise.
_get_term_tree(array $terms, array $arguments = array()) : array
Walk a list of terms and find hierarchy, preserving source order.
array | $terms | Term objects, by reference |
array | $arguments | Shortcode arguments, including defaults |
( [taxonomy] => array( [root terms] => array( [fields], array( 'children' => [child terms] )
_find_include_tree(array $terms, array $include_tree) : mixed
Find the term(s) that match $include_tree
array | $terms | Potential term objects, by reference |
array | $include_tree | term_id(s) of the desired terms |
Term object(s) of the desired terms else false
_count_term_children(object $parent, integer $depth) : integer
Add level to term children and count them, all levels.
Recalculates term counts by including items from child terms. Assumes all relevant children are already in the $terms argument.
object | $parent | Parent Term objects, by reference |
integer | $depth | Maximum depth of parent/child relationship |
Total number of children, all levels
_pad_term_counts( $terms, $taxonomy, $post_types = NULL, $post_stati = NULL) : null
Add count of children to parent count.
Recalculates term counts by including items from child terms. Assumes all relevant children are already in the $terms argument.
$terms | ||
$taxonomy | ||
$post_types | ||
$post_stati |
Will break from function if conditions are not met.