_compose_term_list()
mla_gallery_shortcode()
mla_get_shortcode_attachments()
mla_get_terms()
mla_ghostscript_present()
mla_shortcode_query_posts_clauses_filter()
mla_shortcode_query_posts_clauses_request_filter()
mla_shortcode_query_posts_join_filter()
mla_shortcode_query_posts_orderby_filter()
mla_shortcode_query_posts_where_filter()
mla_tag_cloud()
mla_tag_cloud_shortcode()
mla_term_list()
mla_term_list_shortcode()
_count_term_children()
_find_child_of()
_find_include_tree()
_get_term_tree()
_pad_term_counts()
_paginate_links()
_process_pagination_output_types()
_process_shortcode_parameter()
_registered_dimensions()
_remove_exclude_tree()
_sanitize_query_specification()
_validate_attributes()
_validate_sql_orderby()
$mla_debug
$mla_get_shortcode_attachments_parameters
$mla_get_terms_parameters
$query_parameters
$term_list_item_specific_arguments
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.
package | Media Library Assistant |
---|---|
since | 2.20 |
_compose_term_list(string $list, array $links, array $terms, array $markup_values, array $arguments, array $attr) : void
Adds shortcode output text and term-specific links to arrays passed by reference.
since | 2.25 |
---|
string
Shortcode output text, by reference
array
Term-specific links for flat/array output, by reference
array
Term objects, by reference
array
Style and list-level substitution parameters, by reference
array
Shortcode parameters, including defaults, by reference
array
Shortcode parameters, explicit, by reference
mla_gallery_shortcode(array $attr, string $content) : string
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.
since | 2.20 |
---|
array
Attributes of the shortcode
string
Optional content for enclosing shortcodes; used with mla_alt_shortcode
string
HTML content to display gallery.mla_get_terms(array $attr) : array
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
'
since | 2.20 |
---|
array
taxonomies to search and query parameters
array
array of term objects, empty if none foundmla_ghostscript_present(string $explicit_path, boolean $ghostscript_only) : boolean
since | 2.20 |
---|
string
Non-standard location to override default search, e.g., 'C:\Program Files (x86)\gs\gs9.15\bin\gswin32c.exe'
boolean
Force ghostscript-only tests, used by MLASettings::_compose_mla_gallery_tab()
boolean
true if Ghostscript available else falsemla_shortcode_query_posts_clauses_filter(array $pieces) : array
This is for debug purposes only. Defined as public because it's a filter.
since | 2.20 |
---|
array
query clauses before modification
array
query clauses after modification (none)mla_shortcode_query_posts_clauses_request_filter(array $pieces) : array
This is for debug purposes only. Defined as public because it's a filter.
since | 2.20 |
---|
array
query clauses before modification
array
query clauses after modification (none)mla_shortcode_query_posts_join_filter(string $join_clause) : string
Defined as public because it's a filter.
since | 2.20 |
---|
string
query clause before modification
string
query clause after item modificationmla_shortcode_query_posts_orderby_filter(string $orderby_clause) : string
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.
since | 2.20 |
---|
string
query clause before modification
string
query clause after modificationmla_shortcode_query_posts_where_filter(string $where_clause) : string
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.
since | 2.20 |
---|
string
query clause before modification
string
query clause after modificationmla_tag_cloud(array $attr) : string
This is an alternative to the WordPress wp_tag_cloud function, with additional options to customize the hyperlink behind each term.
since | 2.20 |
---|
array
Attributes of the shortcode.
string
HTML content to display the tag cloud.mla_tag_cloud_shortcode(array $attr, string $content) : string
This is an interface to the mla_tag_cloud function.
since | 2.20 |
---|
array
Attributes of the shortcode.
string
Optional content for enclosing shortcodes
string
HTML content to display the tag cloud.mla_term_list(array $attr) : string
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.
since | 2.25 |
---|
array
Attributes of the shortcode.
string
HTML content to display the term list, dropdown control or checklist.mla_term_list_shortcode(array $attr, string $content) : string
This is an interface to the mla_term_list function.
since | 2.25 |
---|
array
Attributes of the shortcode.
string
Optional content for enclosing shortcodes
string
HTML content to display the term list._count_term_children(object $parent, integer $depth) : integer
Recalculates term counts by including items from child terms. Assumes all relevant children are already in the $terms argument.
since | 2.25 |
---|
object
Parent Term objects, by reference
integer
Maximum depth of parent/child relationship
integer
Total number of children, all levels_find_child_of(array $parents, integer $parent_id) : mixed
since | 2.25 |
---|
array
Potential parent Term objects, by reference
integer
Term_id of the desired parent
mixed
Term object of the desired parent else false_find_include_tree(array $terms, array $include_tree) : mixed
since | 2.25 |
---|
array
Potential term objects, by reference
array
term_id(s) of the desired terms
mixed
Term object(s) of the desired terms else false_get_term_tree(array $terms, array $arguments) : array
since | 2.25 |
---|
array
Term objects, by reference
array
Shortcode arguments, including defaults
array
( [taxonomy] => array( [root terms] => array( [fields], array( 'children' => [child terms] )_pad_term_counts(array $terms, string $taxonomy, array $post_types, array $post_stati) : null
Recalculates term counts by including items from child terms. Assumes all relevant children are already in the $terms argument.
since | 2.20 |
---|
array
Array of Term objects, by reference
string
Term Context
array
Qualifying post type value(s)
array
Qualifying post status value(s)
null
Will break from function if conditions are not met._paginate_links(array $output_parameters, string $markup_values, string $arguments, integer $found_rows, string $output) : mixed
since | 2.20 |
---|
array
value(s) for mla_output_type parameter
string
template substitution values, e.g., ('instance' => '1', ... )
string
merged default and passed shortcode parameter values
integer
number of attachments in the gallery, without pagination
string
output text so far, may include debug values
mixed
false or string with HTML for pagination output types_process_pagination_output_types(array $output_parameters, string $markup_values, string $arguments, string $attr, integer $found_rows, string $output) : mixed
since | 2.20 |
---|
array
value(s) for mla_output_type parameter
string
template substitution values, e.g., ('instance' => '1', ... )
string
merged default and passed shortcode parameter values
string
raw passed shortcode parameter values
integer
number of attachments in the gallery, without pagination
string
output text so far, may include debug values
mixed
false or string with HTML for pagination output types_process_shortcode_parameter(string $text, string $markup_values) : string
since | 2.20 |
---|
string
raw shortcode parameter, e.g., "text {+field+} {brackets} \{braces\}"
string
template substitution values, e.g., ('instance' => '1', ... )
string
parameter with brackets, braces, substitution parameters and templates processed_registered_dimensions() : array
since | 2.20 |
---|
array
_remove_exclude_tree(array $terms, array $exclude_tree) : void
since | 2.25 |
---|
array
Potential term objects, by reference
array
term_id(s) of the desired terms
_sanitize_query_specification(string $specification) : string
since | 2.20 |
---|
string
query specification; PHP nested arrays
string
query specification with HTML escape sequences and line breaks removed_validate_attributes(mixed $attr, string $content) : array
since | 2.20 |
---|
mixed
Array or string containing shortcode attributes
string
Optional content for enclosing shortcodes; might be used with mla_alt_shortcode
array
clean attributes array_validate_sql_orderby(array $query_parameters, string $table_prefix, array $allowed_keys, array $binary_keys) : string | bool
Accepts one or more valid columns, with or without ASC/DESC. Enhanced version of /wp-includes/formatting.php function sanitize_sql_orderby().
since | 2.20 |
---|
array
Validated query parameters; 'order', 'orderby', 'meta_key', 'post__in'.
string
Optional. Database table prefix; can be empty. Default taken from $wpdb->posts.
array
Optional. Field names (keys) and database column equivalents (values). Defaults from [mla_gallery].
array
Optional. Field names (values) that require a BINARY prefix to preserve case order. Default array()
string
bool
Returns the orderby clause if present, false otherwise.$mla_debug : boolean
since | 2.20 |
---|
$mla_get_terms_parameters : array
since | 2.20 |
---|
$query_parameters : array
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
since | 2.20 |
---|
$term_list_item_specific_arguments : array
since | 2.30 |
---|