Download the PHP package gmazzap/url-to-query without Composer
On this page you can find all versions of the php package gmazzap/url-to-query. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download gmazzap/url-to-query
More information about gmazzap/url-to-query
Files in gmazzap/url-to-query
Package url-to-query
Short Description Allow resolving any kind of WordPress url to related main query arguments.
License MIT
Homepage https://github.com/Giuseppe-Mazzapica/Url_To_Query
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package url-to-query
Url To Query
A WordPress plugin that allow resolving any kind of WordPress url (even from custom rewrite rules) to related main query arguments.
Requirements
- PHP 5.4+
- WordPress 3.9+
- Composer to install
Installation
The plugin is a Composer package and can be installed in plugin directory via:
What & Why
WP comes with a set of tools to convert custom urls into specific query variables: is possible to change the permalink structure, and there is also an API to add completely custom rules, however, there is not a way to reverse the process: i.e. to know to which query arguments an arbitrary url is connected to.
The url resolving is done in core by parse_request method of WP class saved in the global $wp variable.
Using that method for the purpose explained above is hard/discouraged because:
- it directly accesses to
$_SERVER,$_POSTand$_GETvariables, making hard to parse arbitrary urls not related with current HTTP request - it triggers some action hooks strictly related to current HTTP request parsing, that makes no sense to trigger for arbitrary urls
- it accesses and modifies properties of global
$wpvariable that should not be changed after request is parsed or very likely things will break
This is the reason why I wrote this simple plugin, it adds a template tag url_to_query that accepts an url and returns related main query arguments.
How to use
It is also possible to pass a relative url:
Using query string
When pretty permalinks are not used, (sometimes even in that case) WordPress can make use of query string in the urls to set query arguments. The plugin works perfectly with them:
To simplify this task, url_to_query accepts a second argument: an array of query vars to be considered
in the same way core considers $_REQUEST variables when an url is parsed:
Note that the array passed as second argument is not straight merged to the query vars, only valid query vars will be used, just like core does when parse urls:
Custom rewrite rules
Plugin works with no problems with custom rewrite rules, just few things to consider:
url_to_queryhave to be called after query rules are added, or it can't recognize them- just like for core, rewrite rules have to be flushed before
url_to_querycan recognize a newly added rule - just like core, if the rule contains custom query variables, they have to be allowed, maybe using
add_rewrite_tagor using'query_vars'filter (see Codex example)
Example:
Plugin classes
Even if plugin provides the 'url_to_query' template tag, it internally uses two classes to resolve urls and
it is possible directly use them, instead of the template tag. Indeed, only one of them should be used, the second is used internally.
So resolve() method of GM\UrlToQuery works exactly in the same way url_to_query function does.
The same instance of GM\UrlToQuery can be used to resolve different urls:
================
License
Url_To_Query is released under MIT.
