Download the PHP package morningtrain/wp-plugin-info without Composer
On this page you can find all versions of the php package morningtrain/wp-plugin-info. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download morningtrain/wp-plugin-info
More information about morningtrain/wp-plugin-info
Files in morningtrain/wp-plugin-info
Package wp-plugin-info
Short Description Helper class to handle info about a plugin
License MIT
Informations about the package wp-plugin-info
Morningtrain\WP\PluginInfo
Get information information about a plugin, based on the plugin file.
Table of Contents
- Introduction
- Getting Started
- Installation
- Usage
- Initialize
- Retrieve Information
- Contributing
- Contributors
- Testing
- License
Introduction
Get information information about a plugin, based on the plugin file.
Getting Started
To get started install the package as described below in Installation.
To use the tool have a look at Usage
Installation
Install with composer
Usage
Initialize
To get started register a plugin file;
Set Slug
You can set a slug by setting Plugin Slug
header in the plugin header.
Alternatively you can set the slug with the setSlug
method on the PluginInfo
instance.
This is useful get the information about your plugin later.
Set a named path
You can set a named path, that you can use to get the path later. It must be an absolute path. You can set a path in the plugin folder or any other place.
Set a named URL
You can set a named URL, that you can use to get the URL later. It must be an absolute URL. You can set a URL in the plugin folder or any other place.
Set a named Parameter
You can set a named parameter, that you can use to get the parameter later. You can set anything with relevance to your plugin.
Retrieve a PluginInfo instance
You can retrieve a PluginInfo instance by using the get
method on the PluginInfo
class.
Retrieve Information
Function | Example | Description |
---|---|---|
getData | $plugin_info->getData('Name', 'Default') |
Get data from plugins data |
getNamedPath | $plugin_info->getNamedPath('pathName') |
Get named path |
getNamedUrl | $plugin_info->getNamedUrl('urlName') |
Get named URL |
getNamedParameter | $plugin_info->getNamedParameter('parameterName') |
Get named parameter |
getRoot | $plugin_info->getRoot() |
Get root path for the plugin |
getRootUrl | $plugin_info->getRootUrl() |
Get root URL for the plugin |
getPluginFilePath | $plugin_info->getPluginFilePath() |
Get path to plugin file |
getBaseName | $plugin_info->getBaseName() |
Base name of plugin ex. "plugin-name/plugin-name.php" |
getSlug | $plugin_info->getSlug() |
Get slug of plugin |
getName | $plugin_info->getName() |
Get name of plugin |
getPluginURI | $plugin_info->getPluginURI() |
Get plugin URI |
getVersion | $plugin_info->getVersion() |
Get version of plugin |
getDescription | $plugin_info->getDescription() |
Get description of plugin |
getAuthor | $plugin_info->getAuthor() |
Get author of plugin - Formatted as link |
getAuthorURI | $plugin_info->getAuthorURI() |
Get author URI |
getTextDomain | $plugin_info->getTextDomain() |
Get textdomain of plugin |
getDomainPath | $plugin_info->getDomainPath() |
Get Translations path |
getRequiresWPVersion | $plugin_info->getRequiresWPVersion() |
Get which WordPress version is required at least |
getRequiresWPVersion | $plugin_info->getRequiresPHPVersion() |
Get which PHP version is required at least |
getUpdateURI | $plugin_info->getUpdateURI() |
Get update URI |
getTitle | $plugin_info->getTitle() |
Get title of plugin |
getAuthorName | $plugin_info->getAuthorName() |
Get author of plugin - Formatted as text |
Contributing
Thank you for your interest in contributing to the project.
Bug Report
If you found a bug, we encourage you to make a pull request.
To add a bug report, create a new issue. Please remember to add a telling title, detailed description and how to reproduce the problem.
Support Questions
We do not provide support for this package.
Pull Requests
- Fork the Project
- Create your Feature Branch (git checkout -b feature/AmazingFeature)
- Commit your Changes (git commit -m 'Add some AmazingFeature')
- Push to the Branch (git push origin feature/AmazingFeature)
- Open a Pull Request
Contributors
- Martin Schadegg Brønniche
- All Contributors
License
The MIT License (MIT). Please see License File for more information.