Download the PHP package johnbillion/args without Composer
On this page you can find all versions of the php package johnbillion/args. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download johnbillion/args
More information about johnbillion/args
Files in johnbillion/args
Package args
Short Description I don't want to get into an argument about this.
License GPL-2.0-or-later
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 args
Args
Many functions and methods in WordPress accept arguments as an associative array which your IDE or code editor cannot autocomplete like it does for individual function parameters.
This library provides well-documented classes which represent many of the associative array parameters used throughout WordPress. Using them at the point where you populate the arguments means you get autocompletion and intellisense in your code editor, and strict typing thanks to typed properties. Comprehensive types and constraints for PHPStan are also included.
Current status
Last updated for WordPress 6.6.
Requirements
- PHP 8.0+
Installation
Changes in version 2
In Args version 2.0 and higher:
- Many arguments have had their type strictness increased for added type safety.
- The
Baseclass which is implemented by all of the Args classes no longer implementsArrayAccess,Countable, orIteratorAggregate. See this issue for further information. - PHP 8.0+ is now required.
Usage
Usage with a class constructor:
Usage with a procedural function parameter:
Meta queries, tax queries, and date queries
The query classes in WordPress support variously meta_query, tax_query, and date_query arguments. These are fully supported and you can construct them in a structured and strongly typed way.
Creating a meta_query argument:
Creating a tax_query argument:
Creating a date_query argument:
Alternatively you can construct a complete query object by calling the fromArray() static method with the same nested array syntax that WordPress core uses:
What's provided
Posts
\Args\WP_Query\Args\register_post_type\Args\wp_insert_post\Args\wp_update_post\Args\get_posts\Args\register_post_meta\Args\register_post_status
Taxonomies and terms
\Args\WP_Term_Query\Args\register_taxonomy\Args\wp_insert_term\Args\wp_update_term\Args\get_terms\Args\get_categories\Args\get_tags\Args\register_term_meta\Args\wp_count_terms\Args\wp_get_object_terms\Args\wp_dropdown_categories
Users
\Args\WP_User_Query\Args\wp_insert_user\Args\wp_update_user\Args\get_users
Comments
\Args\WP_Comment_Query\Args\get_comments
HTTP API
\Args\wp_remote_get\Args\wp_remote_post\Args\wp_remote_head\Args\wp_remote_request\Args\wp_safe_remote_get\Args\wp_safe_remote_post\Args\wp_safe_remote_head\Args\wp_safe_remote_request
Blocks
\Args\WP_Block_Type\Args\register_block_type
Customizer
\Args\WP_Customize_Control\Args\WP_Customize_Manager\Args\WP_Customize_Panel\Args\WP_Customize_Section\Args\WP_Customize_Setting
Everything else
\Args\paginate_links\Args\register_meta\Args\register_rest_field\Args\register_setting\Args\wp_get_nav_menus\Args\wp_nav_menu\Args\wp_die\Args\wp_dropdown_languages\Args\wp_generate_tag_cloud
Type checking
Typed class properties are implemented in this library where possible. If you pass a value of the wrong type to an argument that is typed, you'll get a fatal error as long as you're using strict types:
No more mysterious bugs due to incorrect types.
Note that several parameters in WordPress accept multiple types, for example the $ignore_sticky_posts argument for \WP_Query can be a boolean or an integer. In some of these cases I've opted to type the parameter with the most appropriate type even though it can technically accept other types.
Static analysis
PHPStan-specific @phpstan-var tags are used for properties that have a fixed set of values or other constraints. This allows for even greater type and value checking via static analysis with PHPStan.
Ensure you're using a recent version of PHPStan to make the best use of these constraints.
Contributing
Check out CONTRIBUTING.md for information about generating your own Args definitions or contributing to the Args library.
But why?
I have a name for these array-type parameters for passing arguments. I call them Stockholm Parameters. We've gotten so used to using them that we forget what a terrible design pattern it is. This library exists to work around the immediate issue without rearchitecting the whole of WordPress.
Sponsors
The time that I spend maintaining this library and others is in part sponsored by:
Plus all my kind sponsors on GitHub:
License: GPLv2
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
