Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Instructions for has_notices on plugin level #750

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

Instructions for has_notices on plugin level #750

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions 04-Configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ function my_theme_register_required_plugins() {
'force_deactivation' => false, // If true, plugin is deactivated upon theme switch, useful for theme-specific plugins.
'external_url' => '', // If set, overrides default API URL and points to an external URL.
'is_callable' => '', // If set, this callable will be be checked for availability to determine if a plugin is active.
'has_notices' => true, // If false, this plugin will not be listed in the administrator notices. Useful to hide notice for recommended plugins. Default true.
),

// This is an example of how to include a plugin from the WordPress Plugin Repository.
Expand Down Expand Up @@ -115,6 +116,7 @@ force_activation | boolean | v2.2.0 | Either `true` or `false`. Defaults to `fal
force_deactivation | boolean | v2.2.0 | Either `true` or `false`. Defaults to `false`.<br>If set to `true`, it forces the specified plugin to be deactivated when the current theme is switched. This is useful for deactivating theme-specific plugins.
external_url | string | v2.2.0 | An external URL for the plugin.<br>By default, plugins referenced from the WordPress Plugin Repository are linked to their plugin information via a thickbox overlay. This parameter overrides this default behavior and allows you to specify an alternative URL for the plugin which - when clicked - will be opened in a new tab/window.
is_callable | string\|array | v2.5.0 | Advanced feature. If a plugin can be installed under two or more different slugs - for instance a basic version and a premium version using different slugs -, it might not be recognized correctly as active.<br>By setting `is_callable` to either a function `function_name` from that plugin or a class method - `array( 'class', 'method' )` - similar to how you hook in to actions and filters - TGMPA can still recognize the plugin as being active.
has_notices | boolean | v2.7.0 | Either `true` or `false`. Additinal feature that shows/hides the plugin in administrator notice. Useful to hide notice for recommended plugins. Default value is `true`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor text order and layout change suggestion to be more consistent with the other entries:

Either true or false. Defaults to true.<br>... explanation phrase ...

Also: Additinal => Additional

The text may need further adjustment depending on the discussion I initiated in #749 (review)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will do in about 2h, thnx for pointers.



#### Configuration options
Expand Down