Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rvdforst committed Dec 6, 2024
1 parent 32f62fb commit efd99fe
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/Plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RRZE\WP\Plugin

This PHP library is designed to simplify the management of WordPress plugin files and directories. It provides methods for retrieving information about the plugin, such as its file path, basename, directory, URL, version, and slug.
This PHP library is designed to simplify the management of WordPress plugin files and directories. It provides methods for retrieving information about the plugin, such as its file path, basename, directory, URL, slug, name, version, required WP version and required PHP version.

## Usage

Expand All @@ -21,7 +21,10 @@ $basename = $plugin->getBasename();
$directory = $plugin->getDirectory();
$url = $plugin->getUrl();
$slug = $plugin->getSlug();
$name = $plugin->getName();
$version = $plugin->getVersion();
$requires_wp = $plugin->getRequiresWP();
$requires_php = $plugin->getRequiresPHP();
```

## Methods
Expand All @@ -32,4 +35,7 @@ $version = $plugin->getVersion();
- `getPath(string $path)`: Get the filesystem directory path for a specific file or directory within the plugin.
- `getUrl(string $path)`: Get the URL directory path for a specific file or directory within the plugin.
- `getSlug()`: Get the slug of the plugin.
- `getName()`: Get the name of the plugin.
- `getVersion()`: Get the version of the plugin.
- `getRequiresWP()`: Get the required WordPress version of the plugin.
- `getRequiresPHP()`: Get the required PHP version of the plugin.

0 comments on commit efd99fe

Please sign in to comment.