Document_List implements Registerable, Standard_Service, Conditional
Handles functionality on the Documents list table screen
Tags
Interfaces, Classes and Traits
- Registerable
- Standard_Service
- Conditional
Table of Contents
- add_downloads_column() : array<string|int, mixed>
- Add a download count column.
- add_expired_post_state() : mixed
- Add a post display states for pages and documents
- add_expired_view() : mixed
- Maybe add view link
- add_sortable_key() : array<string|int, mixed>
- Add a download count query key.
- add_taxonomy_dropdowns() : mixed
- Add the taxonomy dropdowns
- downloads_column() : mixed
- Output the download count column.
- handle_expired_view_query() : mixed
- Handle expired query
- handle_sortable_query() : mixed
- Sort by downloads on document list.
- hide_author_column() : array<string|int, mixed>
- Hide the author column by default.
- is_required() : mixed
- {@inheritdoc}
- maybe_add_expired_date_status() : mixed
- Maybe add expired date status
- maybe_add_expired_date_time() : mixed
- Maybe add expired date time
- parse_expired_view_query() : mixed
- Parse expired query
- parse_taxonomy_dropdown_queries() : mixed
- Parses the query for the taxonomy dropdowns.
- register() : mixed
- {@inheritdoc}
- rename_author_column() : array<string|int, mixed>
- Rename the Document Authors column to Document Author
Methods
add_downloads_column()
Add a download count column.
public
add_downloads_column(array<string|int, mixed> $columns) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
Return values
array<string|int, mixed> —add_expired_post_state()
Add a post display states for pages and documents
public
add_expired_post_state(array<string|int, mixed> $post_states, WP_Post $post) : mixed
Parameters
- $post_states : array<string|int, mixed>
-
An array of post display states.
- $post : WP_Post
-
The current post object.
Return values
mixed —add_expired_view()
Maybe add view link
public
add_expired_view(array<string|int, mixed> $views) : mixed
Parameters
- $views : array<string|int, mixed>
Return values
mixed —add_sortable_key()
Add a download count query key.
public
add_sortable_key(array<string|int, mixed> $columns) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
Return values
array<string|int, mixed> —add_taxonomy_dropdowns()
Add the taxonomy dropdowns
public
add_taxonomy_dropdowns() : mixed
Return values
mixed —downloads_column()
Output the download count column.
public
downloads_column(string $column, int $post_id) : mixed
Parameters
- $column : string
- $post_id : int
Return values
mixed —handle_expired_view_query()
Handle expired query
public
handle_expired_view_query(WP_Query $query) : mixed
Parameters
- $query : WP_Query
Return values
mixed —handle_sortable_query()
Sort by downloads on document list.
public
handle_sortable_query(WP_Query $query) : mixed
Parameters
- $query : WP_Query
Return values
mixed —hide_author_column()
Hide the author column by default.
public
hide_author_column(array<string|int, mixed> $hidden, WP_Screen $screen) : array<string|int, mixed>
Parameters
- $hidden : array<string|int, mixed>
-
The list of hidden columns.
- $screen : WP_Screen
-
The current screen.
Return values
array<string|int, mixed> —The list of hidden columns.
is_required()
{@inheritdoc}
public
is_required() : mixed
Return values
mixed —maybe_add_expired_date_status()
Maybe add expired date status
public
maybe_add_expired_date_status(mixed $status, WP_Post $post) : mixed
Parameters
- $status : mixed
- $post : WP_Post
-
The current post object.
Return values
mixed —maybe_add_expired_date_time()
Maybe add expired date time
public
maybe_add_expired_date_time(string $time, WP_Post $post) : mixed
Parameters
- $time : string
- $post : WP_Post
-
The current post object.
Return values
mixed —parse_expired_view_query()
Parse expired query
public
parse_expired_view_query(WP_Query $query) : mixed
Parameters
- $query : WP_Query
Return values
mixed —parse_taxonomy_dropdown_queries()
Parses the query for the taxonomy dropdowns.
public
parse_taxonomy_dropdown_queries(WP_Query $query) : mixed
Parameters
- $query : WP_Query
Return values
mixed —register()
{@inheritdoc}
public
register() : mixed
Return values
mixed —rename_author_column()
Rename the Document Authors column to Document Author
public
rename_author_column(array<string|int, mixed> $columns) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>