Download the PHP package snicco/better-wp-api without Composer
On this page you can find all versions of the php package snicco/better-wp-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download snicco/better-wp-api
More information about snicco/better-wp-api
Files in snicco/better-wp-api
Package better-wp-api
Short Description This small package tries to solve the pain point of not being able to solve to scope code that references WordPress core code.
License LGPL-3.0-only
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 better-wp-api
BetterWPAPI - Interact with WordPress core while keeping your code testable.
BetterWPAPI is a single class that contains proxy methods for some of the most use WordPress core methods.
It's meant to be used in distributed WordPress libraries and helps you to keep your library testable and scopable.
Table of contents
- Motivation
- Installation
- Usage
- Contributing
- Issues and PR's
- Security
Motivation
We developed this library for the WordPress related components of the Snicco project.
Directly interacting with core functions was problematic for us because:
- Code becomes untestable without
- a) booting the entire WordPress codebase or
- b) using additional mocking frameworks (mocking sucks).
- The code becomes really hard to scope using the de-facto standard tool PHPScoper.
- Static analysers like Psalm and PHPStan go crazy over core functions.
If you can't relate to these issues, you probably don't need this library.
Edit: The scoping problem was solved, by us creating
a command-line-programm that can be used to generate
a list of all functions and classes
in the entire WordPress core codebase. For now, the best example on how to use it
is the scoper.inc.php configuration
of the Google Web stories plugin.
Installation
Usage
This is the public API of BetterWPAPI. No public or protected methods will be added until a next major version.
The idea is to limit the interaction with WordPress core to this class.
This has worked very well for us in order to keep our code testable and scopable. You have a single class where you can see all interaction that your library has with core. During tests, you can then simply swap this class with a test double.
The important thing is that: All classes that need anything from WordPress must accept this class as a constructor dependency.
A simple example: (for a real example, check out the BetterWPMail component)
Assuming we have the following class:
This is how we use it in production code.
This is how we test the code. No bootstrapping WordPress needed.
Contributing
This repository is a read-only split of the development repo of the Snicco project.
This is how you can contribute.
Reporting issues and sending pull requests
Please report issues in the Snicco monorepo.
Security
If you discover a security vulnerability within BetterWPAPI, please follow our disclosure procedure.
