Display PDFs / documents by category in list

Here describes how to use shortcodes to display PDFs in specific category / categories in list.

There are two list types and you need call different shortcodes to display what you want.

Shortcodes

[bsk-pdfm-category-ul] for unordered list and [bsk-pdfm-category-ol] for ordered list.

They have same attributes and you may switch the two shortcodes in the following examples.

Common uses

Display PDFs in a category in date descending order
[bsk-pdfm-category-ul id="1" order_by="date" order="DESC"]
click to copy

Single or multiple categories with pagination
[bsk-pdfm-category-ul id="1,2,3,4" order_by="date" order="DESC" pdfs_per_page="10" target="_blank" show_date="yes" date_format="_d/m/Y"]
click to copy

view demo

Multiple categories with search bar, date weekday filter and pagination
[bsk-pdfm-category-ul id="1,2,3,4" order_by="date" order="DESC" pdfs_per_page="10" target="_blank" show_date="yes" date_format="_d/m/Y"]
click to copy

view demo

All categories with search bar, date filter, featured image
[bsk-pdfm-category-ol id="ALL" exclude_id="9,10,11,12,13,14,15,16,17,18,19" order_by="date" order="DESC" pdfs_per_page="10" target="_blank" show_date="yes" date_format="_d/m/Y" show_cat_title="yes" cat_order_by="title" cat_order="ASC" search_bar="YEAR_KEYWORDS" search_bar_year_range="2015-2018" search_bar_year_order="DESC" date_weekday_filter="M-D" date_weekday_filter_right="yes" show_description="yes"]
click to copy

view demo

Shortcode attributes table

Both the two shortcodes have same attributes, the following examples use bsk-pdfm-category-ul but it also work for bsk-pdfm-category-ol.

You may choose the features you want and then add associated attributes to shortcode.

Attribute Values Default
id integer value, ALL
exclude_id integer value
show_cat_title yes no
show_cat_description yes no
password_required yes no
hide_empty_cat yes no
show_cat_empty_message yes no
hierarchical yes no
sub_cat_indent no yes
only_output_pdfs no yes
Examples Description
[bsk-pdfm-category-ul id="1"]
click to copy

view demo

show all PDF/document in category of id = 1
[bsk-pdfm-category-ul id="1,2,3" cat_order_by="date" cat_order="DESC" show_cat_title="yes" show_cat_description="yes" order_by="date" order="DESC"]
click to copy

view demo

show all PDF/documents( in date descending ) in category of id = 1, 2, 3( category in date descending ). Dispaly category title and description above PDF/documents
[bsk-pdfm-category-ul id="20" show_cat_title="yes" show_cat_description="yes" order_by="date" order="DESC" password_required="yes"]
click to copy

view demo

show all PDF/documents in category 20 in date descending and requrie password before show PDF/documents

*  to use password_required="yes" must make sure a password has been set to category

[bsk-pdfm-category-ul id="4" show_cat_title="yes" show_cat_description="yes" hide_empty_cat="yes"]
click to copy

view demo

show all PDF/documents in category 4 but hide all if no PDF/documents in category 4

*  Only work for a single category output

[bsk-pdfm-category-ul id="4" show_cat_title="yes" show_cat_empty_message="yes"]
click to copy

view demo

show all PDF/documents in category 4 and display empty message if no PDF/documents in category 1

*  Only work for a single category output

[bsk-pdfm-category-ul id="19" show_cat_title="yes" show_cat_description="yes" hierarchical="yes"]
click to copy

view demo

show all PDF/documents in category 19 and its sub categories

*  it default have a ident for sub categories

[bsk-pdfm-category-ul id="19" show_cat_title="yes" show_cat_description="yes" hierarchical="yes" sub_cat_indent="no"]
click to copy

view demo

show all PDF/documents in category 19 and its sub categories

*  remove the default ident for sub categories

[bsk-pdfm-category-ul id="1,2,3" only_output_pdfs="yes" order_by="date" order="DESC"]
click to copy

view demo

show all PDF/documents date descendng in category of id = 1, 2, 3

*  only_output_pdfs="yes" only display PDFs and discard all attribute related to category( show_cat_title, show_cat_description, password_required, hide_empty_cat, show_cat_empty_message, hierarchical, sub_cat_indent )

*  id is category id， exclude_id also is for category id

*  only_output_pdfs="yes" provide a way to display PDFs/documents across multiple categories. once it applied then all shortcode related to categoy such as: show_cat_title, show_cat_description, password_required, hide_empty_cat, show_cat_empty_message, hierarchical, sub_cat_indent. So under this mode all PDFs oder by date instead order by category first.

*  password_required="yes", only protect the PDF/document list( links ) not visible to users, does not protect PDF/document itself. To protect PDF/document file please use "Security and users permission module( developing )"

Attribute Values Default
exclude_pdf_id integer value
Examples Description
[bsk-pdfm-category-ul id="1" exclude_pdf_id="7,8,9,10,11,12"]
click to copy

view demo

show all PDF/documents in category of id = 1 but exclude PDF/documents with id of: 7,8,9,10,11,12.
[bsk-pdfm-category-ul id="1" extension="pdf"]
click to copy

view demo

show all PDFs
[bsk-pdfm-category-ul id="1,25" extension="doc,docx,xlsx, pptx"]
click to copy

view demo

show all Microsoft Office files

*  exclude_pdf_id is for PDF/document id

*  extension must be valid value that checked on plugin setting page

Attribute Values Default
cat_order_by title, date title
cat_order ASC, DESC ASC
order_by title, date, custom, id title
order ASC, DESC ASC
Examples Description
[bsk-pdfm-category-ul id="ALL" exclude_id="3,4,5,8", cat_order_by="date" cat_order="DESC"]
click to copy

view demo

display all category but exclude category of id in( 3,4,5,8 ) in date descending one by one, PDFs/documents for every category order by title in ascending

*  PDFs/documents order by title in ascending is default

[bsk-pdfm-category-ul id="ALL" order_by="date" order="DESC"]
click to copy

view demo

display by category date ascending order and PDFs/documents( order by date in descending ) under the category one by one

*  order by category title in ascending is default

[bsk-pdfm-category-ul id="7,8,9,1,2,3,4,5,6" order_by="custom" order="ASC"]
click to copy

view demo

display PDFs/documents in category of id=7,8,9,1,2,3,4,5,6, PDFs/documents order by customer ascending order

*  Check for how to set custom order >>

[bsk-pdfm-category-ul id="7,8,9,1,2,3,4,5,6" order_by="id" order="DESC"]
click to copy

view demo

display PDFs/documents in category of id=7,8,9,1,2,3,4,5,6, PDFs/documents order by id descending

*  for multiple categories, it always order by category and then by PDFs/document.

Attribute Values Default
most_top integer value( > 0 )
year_of year number( ex: 2020 ), 9999( most recent ), year range( ex: 2017-2019 )
month_of month number( ex: 05 mans May ), any year
day_of day number( ex: 03 ), any year any month
weekday_of MON, TUE, WED, THU, FRI, SAT, SUN
Examples Description
[bsk-pdfm-category-ul id="ALL" order_by="date" order="DESC" most_top="20" ]
click to copy

view demo

show the most recent 20 PDFs/documents in all category

*  pagination cannot work if month_of="X" applied

[bsk-pdfm-category-ul id="ALL" year_of="2017-2019" pdfs_per_page="10"]
click to copy

view demo

only show PDFs/documents with date between 2017-01-01 and 2019-12-31 in all category
[bsk-pdfm-category-ul id="ALL" year_of="2017" month_of="06"]
click to copy

view demo

only show PDFs/documents which date in Jun, 2017 in all category
[bsk-pdfm-category-ul id="ALL" day_of="11"]
click to copy

view demo

only show PDFs/documents which date day of 11, donot care year or month
[bsk-pdfm-category-ul id="6" year_of="9999" month_of="99" day_of="99"]
click to copy

view demo

only show PDFs/documents which date is the most recent date in category of id = 6
[bsk-pdfm-category-ul id="6,17" weekday_of="MON"]
click to copy

view demo

only show PDFs/documents which date is Monday in category of id = 6 and 17, donot care year, month or day )

*  Pagination cannot work when most_top="x" applied

Attribute Values Default
pdfs_per_page integer value( > 0 ) 0
pagination_previous_text any string « Previous Page
pagination_next_text any string Next Page »
Examples Description
[bsk-pdfm-category-ul id="ALL" cat_order_by="date" cat_order="DESC" show_cat_title="yes" show_cat_description="yes" order_by="date" order="DESC" pdfs_per_page="10"]
click to copy

view demo

display PDFs/documents in all category in date descending with pagination one by one. Every 10 PDFs/documents on each page
[bsk-pdfm-category-ul id="6" pdfs_per_page="5" pagination_previous_text="Previous" pagination_next_text="Next"]
click to copy

view demo

display PDFs/doucments in category of id = 6, every 5 PDFs/documents on each page and customized previous and next anchor

*  Pagination does't work when most_top="xx" applied

Attribute Values Default
show_count_desc yes no
count_desc_empty any string no records found
count_desc_singular %d + any string %d record found
count_desc_plural %d + any string %d records found
Examples Description
[bsk-pdfm-category-ul id="1,2,6,20,21" search_bar="KEYWORDS" show_count_desc="yes" pdfs_per_page="15"]
click to copy

view demo

display all category of id=1,2,6,20,21 oder in title ascending( default ) and every 15 PDFs/documents on each page with search bar eanbled, the search bar only have keywords field. PDFs/documents order in title ascending( default ). Display count bar above PDFs/documents
[bsk-pdfm-category-ul id="ALL" extension_filter="SPECIFIC" extension_filter_specific="pdf,zip,doc,docx" extension_filter_labels="pdf:Schedule,zip:Attachment,doc:Timesheet,docx:More details" show_count_desc="yes" count_desc_singular="Total: %d" count_desc_plural="Total: %d" pdfs_per_page="15"]
click to copy

view demo

display extension bar and show results count with custom text for all PDFs/documents in all categories
Attribute Values Default
show_date yes no
date_format d, j, l, m, M, F, Y, y d/m/Y
date_before_title yes no
date_prefix custom string
show_description yes no
Examples Description
[bsk-pdfm-category-ul id="1" show_date="yes"]
click to copy

view demo

show PDFs/documents under category of id=1, append date with default format( d/m/Y, example: 25/02/2020 ) after title.
[bsk-pdfm-category-ul id="6" show_date="yes" date_format="--F d, Y" date_prefix="Published on: "]
click to copy

view demo

show PDFs/documents under category of id=6, append date with custom format( F d, Y, example: February 25, 2020 ) after title. And display "Published on: " before PDF date.
[bsk-pdfm-category-ul id="1,6,12" show_date="yes" date_format="Y-m-d " date_before_title="yes"]
click to copy

view demo

show PDFs/documents under category of id=6, add date with custom format( Y-m-d, example: 2020-02-25 ) before title.

*  Check PHP date() Function for more date format

Attribute Values Default
date_weekday_filter Y, m, M, F, d, j, jS, D, l
date_weekday_filter_order DESC, ASC ASC
date_weekday_filter_right yes no
date_weekday_filter_year_option_none any string Year
date_weekday_filter_month_option_none any string Month
date_weekday_filter_day_option_none any string Day
date_weekday_filter_weekday_option_none any string Day of week
Examples Description
[bsk-pdfm-category-ul id="ALL" pdfs_per_page="20" date_weekday_filter="Y-m-d-D" date_weekday_filter_order="DESC-ASC-ASC-ASC" date_weekday_filter_right="yes"]
click to copy

view demo

display all PDFs/documents in all category, category order in title ascending( defualt ), PDFs/documents in title ascending( default ), date weekday fitler above PDFs/documents list on right.

*  The date_weekday_filter & date_weekday_filter_order separated by - and can use one or all of them

[bsk-pdfm-category-ul id="ALL" pdfs_per_page="20" date_weekday_filter="Y-m-d-D" date_weekday_filter_order="DESC-ASC-ASC-ASC" date_weekday_filter_right="yes" date_weekday_filter_year_option_none="Anno" date_weekday_filter_month_option_none="Mese" date_weekday_filter_day_option_none="Giorno" date_weekday_filter_weekday_option_none="Giorno della settimana"]
click to copy

view demo

display all PDFs/documents in all category, category order in title ascending( defualt ), PDFs/documents in title ascending( default ), date weekday fitler above PDFs/documents list on right.

*  The text on year, month, day, day of week selects were overwritten

[bsk-pdfm-category-ul id="6,12,17" date_weekday_filter="Y" date_weekday_filter_order="DESC" order_by="date" order="DESC" most_top="15"]
click to copy

view demo

display the most recent 15 PDFs/documents in category 6,12,17, show year filter above PDFs/documents
[bsk-pdfm-category-ul id="ALL" pdfs_per_page="30" date_weekday_filter="Y-D" date_weekday_filter_order="DESC-ASC"]
click to copy

view demo

show year and weekday in filter, year in descending and month in ascending

*  This filter only apply to the current PDFs/documents results it won't query PDFs/documents from database

*  For year the support format is: Y( eg: 2020 )

*  For month the support format is: m( eg: 01 ), M( eg: Dec ), F( eg: February )

*  For day the support format is: d( eg: 25 ), j( eg: 25 ), jS( eg: 25th )

*  For weekday the support format is: D( eg: Tue ), l( lower case of L, eg: Tuesday )

Attribute Values Default
date_weekday_query_filter ALL_EXISTED, SPECIFIC no
date_weekday_query_filter_format Y, m, M, F, d, j, jS, D, l, Y-m|M|F-d|j|jS-D|l Y-F-jS-D
date_weekday_query_filter_range YEAR_start:YEAR_end-MONTH_start:MONTH_end-DAY_start:DAY_end-WEEKDAY_start:WEEKDAY_end 2000:2020-1:12-1:31-MON:SUN
date_weekday_query_filter_order DESC, ASC DESC-ASC-ASC-ASC
date_weekday_filter_year_option_none any string Year
date_weekday_filter_month_option_none any string Month
date_weekday_filter_day_option_none any string Day
date_weekday_filter_weekday_option_none any string Day of week
date_weekday_query_filter_right yes no
date_weekday_query_filter_only yes no
date_weekday_query_filter_sunday_first yes no
Examples Description
[bsk-pdfm-category-ul id="ALL" order_by="date" order="DESC" date_weekday_query_filter="ALL_EXISTED" pdfs_per_page="10"]
click to copy

view demo

display date weekday query filter above PDFs, change dropdown to query PDFs with selected year, monthy, day and day of week. All categories included.
[bsk-pdfm-category-ul id="1" cat_order_by="date" cat_order="DESC" order_by="date" order="DESC" date_weekday_query_filter="ALL_EXISTED" date_weekday_query_filter_format="Y-F" pdfs_per_page="10"]
click to copy

view demo

display year and month as query filter, only show PDFs in category 1
[bsk-pdfm-category-ul id="1,2,6,12,17" order_by="date" order="DESC" date_weekday_query_filter="SPECIFIC" date_weekday_query_filter_range="2015:2020-MON:SUN" date_weekday_query_filter_format="Y-l"]
click to copy

view demo

display specific date weekday query filter, set year range from 2015 to 2020 and day of week from Monday to Sunday. Only include PDFs in category of id=1,2,6,12,17
[bsk-pdfm-category-ul id="1,2,6,12,17" order_by="date" order="DESC" date_weekday_query_filter="ALL_EXISTED" date_weekday_query_filter_format="Y-F" date_weekday_filter_year_option_none="Select year..." date_weekday_filter_month_option_none="Select month..." date_weekday_query_filter_right="yes" date_weekday_query_filter_only="yes"]
click to copy

view demo

display year and month as query filter, place query filter bar on right, only show query filter bar( without PDFs at first), change dropdown option null to specific text. Only include PDFs in category of id=1,2,6,12,17

*  This filter shows year, month, day, day of week in dropdowns above and load documents whose date same as selected values.

*  The filter different from Date weekday filter, this one loads documents from databse when filter change.

*  date_weekday_query_filter_only="yes" means no PDFs/documents listed at first

Attribute Values Default
extension_filter ALL, ALL_EXISTED, SPECIFIC no
extension_filter_default a valid extension
extension_filter_specific valid extensions
extension_filter_labels extension:label
extension_filter_exclude valid extensions
extension_filter_only yes no
Examples Description
[bsk-pdfm-category-ul id="ALL" order_by="date" order="DESC" extension_filter="ALL"]
click to copy

view demo

display all supported extensions above PDFs/documents list. PDFs/documents order by category title ascending and then PDFs/document's date descending.
[bsk-pdfm-category-ul id="ALL" order_by="date" order="DESC" extension_filter="ALL" extension_filter_default="pdf"]
click to copy

view demo

same as above but set default extension to PDF, it means only PDFs shown at first
[bsk-pdfm-category-ul id="ALL" order_by="date" order="DESC" extension_filter="ALL_EXISTED"]
click to copy

view demo

only show extensions that have PDFs/documents managed. Extension filer bar placed above PDFs/documents results. PDFs/documents order by category title ascending and then PDFs/document's date descending.
[bsk-pdfm-category-ul id="1,2,6,12,17" extension_filter="SPECIFIC" extension_filter_specific="pdf,zip,doc,docx"]
click to copy

view demo

Display all PDFs/documents under category of id=1,2,6,12,17. show specifc extensions, the extensions given by extension_filter_specific
[bsk-pdfm-category-ul id="ALL" extension_filter="SPECIFIC" extension_filter_specific="pdf,zip,doc,docx" extension_filter_labels="pdf:Schedule,zip:Attachment,doc:Timesheet,docx:More details" show_count_desc="yes"]
click to copy

view demo

Display all PDFs/documents under all category. show specifc extensions with labels. Labes will be shown above PDFs/documents instead extensions. Order by catetory title ascending first and then PDFs/documents title ascending( default )
[bsk-pdfm-category-ul id="1,2,6,17" extension_filter="ALL_EXISTED" extension_filter_only="yes" show_count_desc="yes"]
click to copy

view demo

Display all PDFs/documents under category of id=1,2,6,17. only show extensions bar that have PDFs/documents managed, without PDFs/documents. Also show results count.

*  extension_filter_only="yes" means no PDFs/documents listed at first( even extension_filter_default given), so just extensions there.

*  This filter shows extensions that choosen on plugin setting page. It will show extensions above and load documents that have clicked extension.

*  This filter will overwrtie the extension attribute

Attribute Values Default
title_filter ALPHABET, ALPHABET_EXISTED, SPECIFIC no
title_filter_default valid title
title_filter_specific valid title
title_filter_first_x_chars integer value( work with ALPHABET_EXISTED ) 1
title_filter_exclude any string
title_filter_only yes no
Examples Description
[bsk-pdfm-category-ul id="ALL" order_by="date" order="DESC" title_filter="ALPHABET"]
click to copy

view demo

display all PDFs/documents in all category, display alphabet( A - Z ) as title start filter above PDFs/documents list. Order by category title in ascending then by PDFs/documents date descending
[bsk-pdfm-category-ul id="ALL" cat_order_by="date" cat_order="DESC" order_by="date" order="DESC" title_filter="ALPHABET" title_filter_default="C" ]
click to copy

view demo

display all PDFs/documents in all category, display alphabet( A - Z ) as title start filter above PDFs/documents list and set C as default chosen filter. Order by category date in descending then by PDFs/documents date descending
[bsk-pdfm-category-ul id="1,2,6,12,17" order_by="date" order="DESC" title_filter="ALPHABET_EXISTED"]
click to copy

view demo

display all PDFs/documents under category of id=1,2,6,12,17 with available first char of title from database as title start filter above PDFs/documents list
[bsk-pdfm-category-ul id="1,2,6,12,17" order_by="date" order="DESC" title_filter="ALPHABET_EXISTED" title_filter_first_x_chars="3"]
click to copy

view demo

display all available first 3 chars from database as title start filter above PDFs/documents list
[bsk-pdfm-category-ul id="ALL" order_by="date" order="DESC" title_filter="ALPHABET_EXISTED" title_filter_first_x_chars="2" title_filter_exclude="In,Se"]
click to copy

view demo

display all available first 2 chars from database( and exclude In, Se ) as title start filter above PDFs/documents list
[bsk-pdfm-category-ul id="1" title_filter="SPECIFIC" title_filter_specific="Traffic,Board" title_filter_default="Board"]
click to copy

view demo

display all PDFs/documents under category of id=1, show specifc title start string to filter documents, given by title_filter_specific
[bsk-pdfm-category-ul id="1,12,21" title_filter="SPECIFIC" title_filter_specific="Traffic,Board" title_filter_only="yes" show_count_desc="yes"]
click to copy

view demo

display all PDFs/documents under category of id=1,12,21, show specifc title start string to filter documents, only show PDFs/documents after filter clicked, also show results count.

*  This filter shows string above and load documents that title start with clicked extension.

*  title_filter_only="yes" means no PDFs/documents listed at first( even title_filter_default given).

Attribute Values Default
tags ALL, ASSIGNED, SPECIFIC
tags_default tag id
tags_exclude tag id, separate by comma
tags_specific tag id, separate by comma
tags_align_right no, yes no
tags_order_by date, title title
tags_order ASC, DESC ASC
Examples Description
[bsk-pdfm-category-ul id="ALL" order_by="date" order="DESC" tags="ALL" tags_order_by="date" tags_order="DESC"]
click to copy

view demo

display all PDFs/documents in all category, display all tags above as anchor
[bsk-pdfm-category-ul id="ALL" cat_order_by="date" cat_order="DESC" order_by="date" order="DESC" tags="ASSIGNED" tags_exclude="1,2" tags_align_right="yes" ]
click to copy

view demo

only display tags that assigned to PDFs / documents

*  Tags with ID of 1 and 2 will be excluded

[bsk-pdfm-category-ul id="ALL" order_by="date" order="DESC" tags="SPECIFIC" tags_specific="8,11,23,14,26,28"]
click to copy

view demo

display tags with ID of 8,11,23,14,26,28

*  Tags name will be show as anchor above PDFs/documents list, load PDFs by AJAX when click tag

Advanced uses

Output container class

Use shortcode parameter of output_container_class to add your own class name to the shortcode output container if you'd like to do custom CSS. Example: [bsk-pdfm-category-ul id="1" output_container_class="my_idenfity_PDFs_container_class"]

Filters & Hooks

Filters & Hooks

Purchase BSK PDF Manager Pro