Make WordPress Core

wiki:TracQuery

Version 3 (modified by trac, 19 years ago) (diff)

--

Trac Ticket Queries

In addition to reports, Trac provides support for custom ticket queries, used to display lists of tickets meeting a specified set of criteria.

To configure and execute a custom query, switch to the View Tickets module from the navigation bar, and select the Custom Query link.

Filters

When you first go to the query page the default filters will display all open tickets, or if you're logged in it will display open tickets assigned to you. Current filters can be removed by clicking the button to the right with the minus sign on the label. New filters are added from the pulldown list in the bottom-right corner of the filters box. Filters with either a text box or a pulldown menu of options can be added multiple times to perform an or of the criteria.

You can use the fields just below the filters box to group the results based on a field, or display the full description for each ticket.

Once you've edited your filters click the Update button to refresh your results.

Clicking on one of the query results will take you to that ticket. You can navigate through the results by clicking the Next Ticket or Previous Ticket links just below the main menu bar, or click the Back to Query link to return to the query page.

You can safely edit any of the tickets and continue to navigate through the results using the Next/Previous/Back to Query links after saving your results. When you return to the query any tickets which was edited will be displayed with italicized text. If one of the tickets was edited such that it no longer matches the query criteria the text will also be greyed. Lastly, if a new ticket matching the query critera has been created, it will be shown in bold.

The query results can be refreshed and cleared of these status indicators by clicking the Update button again.

Saving Queries

While Trac does not yet allow saving a named query and somehow making it available in a navigable list, you can save references to queries in Wiki content, as described below.

You may want to save some queries so that you can come back to them later. You can do this by making a link to the query from any Wiki page.

[query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]

Which is displayed as:

Active tickets against 1.0

This uses a very simple query language to specify the criteria (see Query Language).

Alternatively, you can copy the query string of a query and paste that into the Wiki link, including the leading ? character:

[query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]

Which is displayed as:

Assigned tickets by owner

Using the [[TicketQuery]] Macro

The [[TicketQuery]] macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.

Example:

[[TicketQuery(version=1.0|2.0&resolution=duplicate)]]

This is displayed as:

#1993
Problem with plug-ins management, v2 RC1
#2079
Text field of "Size of the post box" setting in options-writing.php not large enough in Safari
#2128
left allign the code tag
#2140
Right panel in "Write post" doesn't look good in Opera (RC3)
#2158
TinyMCE load default lang file only
#2171
Mysql 5 and STRICT mode (and possibly WIMP)
#2178
<!--more--> tag get stripped in RTE for users with role different than Administratos
#2226
<!--more--> tag is not handled correctly when posting via XML-RPC
#2229
function-post.php bug in both 1.5.1 and 2.0
#2240
Apostrophe in name or description or translation of attachment
#2241
<a>, <ul>, <div> items are stripped when posting via XML-RPC
#2246
"Remember Me" function doesn't work - always have to login, WP2.0
#2248
inconsistent number of posts in wp_list_cats() and wp_get_archives()
#2264
Deleting comments with mass-edit mode does not update comment counts
#2265
AJAX delete-page/post permission check uses wrong variable
#2272
about box html translated to entities
#2276
wp_upload_bits bad variable name
#2279
Inconsistent Dashboard Layout
#2282
Ability to add categories on the fly in post.php lost [from: wp-testers]
#2287
embed content stripped when posting through XML-RPC
#2303
More thorough filename sanitization
#2308
use_fileupload option should be restored
#2310
Enclosing https does not work
#2356
Image names using the single quote character cause problems in WordPress 2.0
#2358
Transform HTML Special Chars in comment-functions.php:comments_popup_link()
#2392
Upgrade to Tiny_MCE 2.0.2
#2396
Not found in stead of 404
#2770
division by zero
#3509
Error trackback charset
#22698
Broken capability checks with current_user_can() + map_meta_cap()
#23151
get_attachment_template() doesn't follow the pattern of its get_{type}_template() siblings
#23778
How do you keep WordPress from removing the non-breaking space?
#26419
maybe_create_table is very resource intensive
#41200
Documentation outdated for current_user_can()
#62025
Unable to use wp_kses* with JavaScript templating

Just like the query: wiki links, the parameter of this macro expects a query string formatted according to the rules of the simple ticket query language.

A more compact representation without the ticket summaries is also available:

[[TicketQuery(version=1.0|2.0&resolution=duplicate, compact)]]

This is displayed as:

#1993, #2079, #2128, #2140, #2158, #2171, #2178, #2226, #2229, #2240, #2241, #2246, #2248, #2264, #2265, #2272, #2276, #2279, #2282, #2287, #2303, #2308, #2310, #2356, #2358, #2392, #2396, #2770, #3509, #22698, #23151, #23778, #26419, #41200, #62025

Query Language

query: TracLinks and the [[TicketQuery]] macro both use a mini “query language” for specifying query filters. Basically, the filters are separate by ampersands (&). Each filter then consists of the ticket field name, an operator, and one or more values. More than one value are separated by a pipe (|), meaning that the filter matches any of the values.

The available operators are:

= the field content exactly matches the one of the values
~= the field content contains one or more of the values
^= the field content starts with one of the values
$= the field content ends with one of the values

All of these operators can also be negated:

!= the field content matches none of the values
!~= the field content does not contain any of the values
!^= the field content does not start with any of the values
!$= the field content does not end with any of the values

See also: TracTickets, TracReports, TracGuide