TGMPA / TGM-Plugin-Activation

TGM Plugin Activation is a PHP library that allows you to easily require or recommend plugins for your WordPress themes (and plugins). It allows your users to install, update and even automatically activate plugins in singular or bulk fashion using native WordPress classes, functions and interfaces. You can reference bundled plugins, plugins from the WordPress Plugin Repository or even plugins hosted elsewhere on the internet.
http://tgmpluginactivation.com/
GNU General Public License v2.0
1.76k stars 429 forks source link

Fixed an invalid path preventing the install of the bundled example plugin #637

Closed mmcev106 closed 7 years ago

jrfnl commented 7 years ago

The example file contains an example path, in this case a path which presumes that TGMPA lives in a lib subdirectory and has been unzipped there including the example file (which then would live in lib/plugins).

The example file is there to help developers implement TGMPA. Your change would suggest that TGMPA would/should have been unzipped and live in the root of a theme or plugin which is something I for one would definitely strongly advise against.

mmcev106 commented 7 years ago

Interesting, thanks for the clarification. The installation directions just say "Drop the class file somewhere in your theme or plugin hierarchy", so I just dropped it directly in my theme root. It took me a minute to figure out why installing the bundled plugin was not working. I wonder if it would be worth changing the installation instructions to include the suggested "lib" subdirectory.

On Mon, Oct 24, 2016 at 12:22 PM, Juliette notifications@github.com wrote:

The example file contains an example path, in this case a path which presumes that TGMPA lives in a lib subdirectory and has been unzipped there including the example file (which then would live in lib/plugins).

The example file is there to help developers implement TGMPA. Your change would suggest that TGMPA would/should have been unzipped and live in the root of a theme or plugin which is something I for one would definitely strongly advise against.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/TGMPA/TGM-Plugin-Activation/pull/637#issuecomment-255806268, or mute the thread https://github.com/notifications/unsubscribe-auth/ACgZDtnviRsHPfPvCA_PM4G0Og5bzAQqks5q3OlFgaJpZM4Ke7ts .

jrfnl commented 7 years ago

I would venture that the place in the theme.plugin directory hierarchy is up to the developer, it really doesn't matter for TGMPA itself. (Though root level is not advised.) We'd welcome a PR, if you can come up with a good clarification of the installation instructions (readme/example file/gh-pages branch web).