These shortcodes and widget are available both in their historic form and as blocks.
Existing shortcodes can be converted to and from their block forms.
They are held in a grouping called WP Document Revisions.
Since the blocks make use of dynamically-generated content, the same code is used to create this for a shortcode/widget.
In a post or page, simply type [documents] to display a list of documents.
The shortcode accepts most Standard WP_Query parameters which should allow you to fine tune the output. Parameters are passed in the form of, for example, [documents numberposts="5"].
Specifically, the shortcode accepts: author__in, author__not_in, author_name, author, cat, category__and, category__in, category__not_in, category_name, date_query, day, has_password, hour, m, meta_compare, meta_key, meta_query, meta_value_num, meta_value, minute, monthnum, name, numberposts, order, orderby, p, page_id, pagename, post__in, post__not_in, post_name__in, post_parent__in, post_parent__not_in, post_parent, post_password, post_status, s, second, tag__and, tag__in, tag__not_in, tag_id, tag_slug__and, tag_slug__in, tag, tax_query, title, w and year.
If you’re using a custom taxonomy, you can add the taxonomy name as a parameter in your shortcode. For example, if your custom taxonomy is called “document_categories”, you can write insert a shortcode like this:
[documents document_categories="category-name" numberposts="6"]
(Where “category-name” is the taxonomy term’s slug)
It accepts the “query_var” parameter of the taxonomies used for documents. That is, if you have defined a taxonomy for your documents with slug “document_categories”. If you have not defined the query_var parameter then you use the slug. However if you have set query_var to “doc_cat”, say, then you can insert a shortcode as
[documents doc_cat="category-name" numberposts="5"]
Important parameters WP_Query will be the ordering and number of posts to display.
numberposts (with a number parameter) will give the maximum number of posts to display.
order (with value ‘ASC’ or ‘DESC’) gives the ordering,
orderby (with a string value) gives the field to order the documents. Common values are “title”, “date”, “name”, “modified” and “ID”.
It is also possible to add formatting parameters:
show_edit (with a true/false parameter) that can add a link next to each document shown in the list that the user is able to edit by them. This permits the user to edit the document directly from the list. A value set here will override the default behaviour.
As delivered, administrators will have the show_edit implicitly active. A filter document_shortcode_show_edit can be used to set this for additional user roles.
new_tab (with a true/false parameter) that will open the document in a new browser tab rather than in the current one.
show_pdf (with a true/false parameter) that, for accessibility, will display (PDF) as part of links if this links to a PDF document.
show_thumb (with a true/false parameter) that will display a featured image (or generated one from the first page of PDF documents) if provided.
show_descr (with a true/false parameter) that will output the entered description if provided.
All these boolean variables can be entered without a value (with default value true except for show_thumb whose default value is false).
When using the block version of the shortcode called Document List, some compromises have been necessary.
Since queries are often selecting a single taxonomy value, the block provides the possibility to select single values from up to three taxonomies. Since there can be more than three taxomomies attached to documents, a filter document_block_taxonomies allows the list of taxonomies to be edited to select the taxonomies to be displayed.
The parameters numberposts, order, orderby, show_edit,new_tab, show_thumb and show_descr are directly supported. However, since there are many other parameters are possible, as well as differet structures, additional parameters may be entered as a text field as held in the shortcode.
Note that this section does not refer to the terms used within a taxonomy are changed but to changes made when taxonomies are registereed with documents.
It is possible that the taxonomies associated with documents are changed. Since the three taxonomies are chosen when the block is created, then if the taxonomies linked are subsequently changed, then a warning/error message “Taxonomy details in this block have changed.” may be seen when the block is output.
The resolution to this issue is to transform the block to a shortcode and then back to a block again. A side effect will be to lose any “supports” properties (see below) that have been used.
In a post or page, simply type [document_revisions id="100"] where ID is the ID of the document for which you would like to list revisions.
You can find the ID in the URL of the edit document page.
To limit the number of revisions displayed, passed the “number” argument, e.g., to display the 5 most recent revisions [document_revisions id="100" number="5"].
It is also possible to add formatting parameters:
numberposts (with a number parameter) will give the maximum number of revisions to display.
summary (with a true/false parameter) that will add the excerpt for the revision to the output.
new_tab (with a true/false parameter) that will open the revision in a new browser tab rather than in the current one.
show_pdf (with a true/false parameter) that, for accessibility, will display (PDF) as part of links if this links to a PDF document.
These boolean variables can be entered without a value (with default value true ).
When using the block version of the shortcode called Document Revisions, a change have been necessary.
number is a reserved word within javascript so numberposts is also supported even for the shortcode format. numberposts is used by the block.
Since the block is dynamically displayed as parameters are entered, if the post number entered is not a document, then an appropriate message will be entered.
Go to your theme’s widgets page (if your theme supports widgets), and drag the widget to a sidebar of you choice. Once in a sidebar, you will be presented with options to customize the widget’s functionality.
It is also possible to add formatting parameters:
numberposts (with a number parameter) will give the maximum number of revisions to display.
Post Status allowing the selection “publish”, “private” or “draft”, or combination of them.
show_thumb (with a true/false parameter) that will display a featured image (or generated one from the first page of PDF documents) if provided.
show_descr (with a true/false parameter) that will output the entered description if provided.
show_author(with a true/false parameter) that will identify the document author.
new_tab (with a true/false parameter) that will open the revision in a new browser tab rather than in the current one.
show_pdf (with a true/false parameter) that, for accessibility, will display (PDF) as part of links if this links to a PDF document.
The block version of the widget called Latest Documents can be used on pages or posts. It cannot be converted to or from a shortcode block as there is no equivalent.
Additionally, later versions of WordPress provide for blocks to support additional display attributes that will be applied to the block on rendering if the theme allows it.
These attributes are align, color, spacing and typography and these attributes have been added to all blocks.