PHP download

Download the PHP package robertdevore/wpcom-check without Composer

On this page you can find all versions of the php package robertdevore/wpcom-check. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download robertdevore/wpcom-check
More information about robertdevore/wpcom-check
Files in robertdevore/wpcom-check

Vendor robertdevore
Package wpcom-check
Short Description A utility to handle WordPress.com-specific plugin compatibility and auto-deactivation.
License MIT
Homepage https://github.com/robertdevore/wpcom-check

Keywords plugin wordpress compatibility wordpress.com deactivation

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

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.

Please rate this library. Is it a good library?

Example code of robertdevore/wpcom-check

Informations about the package wpcom-check

WPCom Check

WPCom Check is a WordPress® utility designed to ensure compatibility with WordPress.com-hosted environments.

It provides automated plugin deactivation and user notifications if a plugin is not supported on WordPress.com.

This tool is ideal for plugin developers who want to ensure their plugins gracefully handle unsupported hosting environments.

Features

Automatically detects if the site is hosted on WordPress.com.
Deactivates the plugin if unsupported.
Displays an admin notice with information about the deactivation.
Prevents activation on unsupported environments.
Allows developers to provide a custom learn-more link for user education.

Installation

Using Composer

Add the package to your project:

Include Composer's autoload file in your plugin or theme:

Instantiate the WPComPluginHandler class in your plugin's main file:

Manual Installation

Clone or download the repository from GitHub:

Include the WPComPluginHandler.php file in your project:

Instantiate the class in your plugin's main file:

Usage

Parameters

**$pluginSlug**: (string) The plugin slug, typically obtained using plugin_basename(__FILE__).
**$learnMoreLink**: (string) A URL pointing to more information about the deactivation reason or alternative solutions.

Example

Here is how to use WPCom Check in your plugin:

How It Works

Detection: The WPComPluginHandler checks if the site is hosted on WordPress.com by inspecting the IS_WPCOMconstant.
Deactivation: If the plugin is running in an unsupported environment, it is deactivated automatically.
Admin Notice: An admin notice is displayed, providing users with a link to learn more about the issue.
Activation Prevention: The plugin prevents itself from being activated on unsupported environments, displaying a detailed error message.

Developer Notes

Ensure you use the correct plugin slug when instantiating the class.
Customize the learn-more link to provide users with appropriate guidance.
Use Composer for a streamlined installation and updates.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your improvements.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

For questions or issues, please create a GitHub issue at github.com/robertdevore/wpcom-check.

All versions of wpcom-check with dependencies

PHP Build Version

Package Version

Version 1.0.1 Release 07. Jan 2025
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of wpcom-check from vendor robertdevore

Requires php Version >=7.4

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package robertdevore/wpcom-check contains the following files

Loading the files please wait ....