Title: WP Contextual Help Author: Kevin Langley Jr. Published: 22 de Julio de 2014 Last modified: 5 de Enero de 2015 --- Buscar plugins ![](https://ps.w.org/wp-contextual-help/assets/banner-772x250.png?rev=952541) Este plugin **no ha sido probado con ninguna las 3 últimas versiones principales de WordPress**. Puede que ya no se mantenga o no tenga soporte, y puede que tenga problemas de compatibilidad cuando se utiliza con versiones más recientes de WordPress. ![](https://s.w.org/plugins/geopattern-icon/wp-contextual-help_d94965.svg) # WP Contextual Help Por [Kevin Langley Jr.](https://profiles.wordpress.org/kevinlangleyjr/) [Descargar](https://downloads.wordpress.org/plugin/wp-contextual-help.1.0.2.zip) * [Detalles](https://cl.wordpress.org/plugins/wp-contextual-help/#description) * [Reseñas](https://cl.wordpress.org/plugins/wp-contextual-help/#reviews) * [Instalación](https://cl.wordpress.org/plugins/wp-contextual-help/#installation) * [Desarrollo](https://cl.wordpress.org/plugins/wp-contextual-help/#developers) [Soporte](https://wordpress.org/support/plugin/wp-contextual-help/) ## Descripción Adds helper functionality to easily add to the WP Contextual Help throughout the admin of a WordPress site. #### Usage When you register a tab you have a few different options as far as what content is displayed there. If you provide a callback argument in the tab args, that will take precedence and the plugin will not look for any HTML files within the help-docs directory. If you provide a file argument in the tab args, the plugin will look for that file specifically and if it does not exist will output a warning message in place of the content to notify the developer that the specified help document does not exist. If no file or callback argument is passed into the tab args, by default the plugin will look for a file with the same name as the id of the tab. So for `post-management` it would look for `post-management.html` within the help docs directory. #### HTML Help Docs All help docs should either reside within the `get_template_directory() . '/includes/ help-docs/';` directory and all images within the `get_template_directory() . '/ includes/help-docs/img/';` You can use the `wp_contextual_help_docs_dir` filter to change the directory for the HTML files and the `wp_contextual_help_docs_url` filter to change the base URL for the images. Within your help documentation we use the variable `{WP_HELP_IMG_URL}` as a placeholder for the image URL which is then replaced before rendering with the value provided from the filter or defaults to the default help docs image directory. #### Registering a tab Help tabs are registered using the `WP_Contextual_Help::register_tab()` method. **Parameters** * `$id` (string) – String to be used as the ID for the help tab * `$title` (string) – Title to display to the user within the tab * `$args` (array) – An array of options for the help tab - `page` (string, array) – Page(s) to enable the help tab - `post_type` (string, array) – Limit the tab to only display on these specific post types - `file` (string) – HTML file to read and output within the tab - `wpautop` (boolean) – Default: False – Apply wpautop to the loaded HTML file - `callback` – If a user would rather a custom callback instead of the autoloading of a HTML file, this is where that would be applied #### Example ``` array( 'post.php', 'post-new.php' ), 'post_type' => 'post', 'wpautop' => true ) ); // Add to a custom admin page WP_Contextual_Help::register_tab( 'custom-settings', 'Custom Settings', array( 'page' => 'settings_page_custom-settings-page', 'wpautop' => true ) ); // Add help tab with custom callback WP_Contextual_Help::register_tab( 'custom-callback', 'Custom Callback Example', array( 'page' => array( 'post.php', 'post-new.php' ), 'post_type' => 'post', 'callback' => function( $screen, $tab ) { echo '

It is super easy to add new help tabs!

'; } ) ); } ); ?> ``` ## Instalación #### As standard plugin: > See [Installing Plugins](https://codex.wordpress.org/Managing_Plugins#Installing_Plugins). #### As theme or plugin dependency: > After dropping the plugin into the containing theme or plugin, add the following: ``` if( ! class_exists( 'WP_Contextual_Help' ) ) { require_once( $path_to_help . '/wp-contextual-help.php' ); } ``` #### As a composer dependency Add the following to your composer.json required dependencies ``` { // ... "require": { "voceconnect/wp-contextual-help": "~0.0.1" // Most recent tagged version }, // ... } ``` ## Reseñas No hay reseñas para este plugin. ## Colaboradores & Desarrolladores “WP Contextual Help” es software de código abierto. Las siguientes personas han contribuido a este plugin. Colaboradores * [ Kevin Langley Jr. ](https://profiles.wordpress.org/kevinlangleyjr/) [Traduce “WP Contextual Help” a tu idioma.](https://translate.wordpress.org/projects/wp-plugins/wp-contextual-help) ### ¿Interesado en el desarrollo? [Revisa el código](https://plugins.trac.wordpress.org/browser/wp-contextual-help/), echa un vistazo al [repositorio SVN](https://plugins.svn.wordpress.org/wp-contextual-help/), o suscríbete al [registro de desarrollo](https://plugins.trac.wordpress.org/log/wp-contextual-help/) por [RSS](https://plugins.trac.wordpress.org/log/wp-contextual-help/?limit=100&mode=stop_on_copy&format=rss). ## Historial de cambios Please refer to full changelog at https://github.com/voceconnect/wp-contextual-help/ releases. ## Meta * Versión **1.0.2** * Última actualización **hace 12 años** * Instalaciones activas **Menos de 10** * Versión de WordPress ** 3.3 o superior ** * Probado hasta **4.1.42** * Idioma * [English (US)](https://wordpress.org/plugins/wp-contextual-help/) * Etiquetas * [contextual](https://cl.wordpress.org/plugins/tags/contextual/)[help](https://cl.wordpress.org/plugins/tags/help/) * [Vista Avanzada](https://cl.wordpress.org/plugins/wp-contextual-help/advanced/) ## Calificaciones Aún no se han enviado valoraciones. [Tu reseña](https://wordpress.org/support/plugin/wp-contextual-help/reviews/#new-post) [Ver todas las reseñas](https://wordpress.org/support/plugin/wp-contextual-help/reviews/) ## Colaboradores * [ Kevin Langley Jr. ](https://profiles.wordpress.org/kevinlangleyjr/) ## Soporte ¿Tienes algo que decir? ¿Necesitas ayuda? [Ver el foro de soporte](https://wordpress.org/support/plugin/wp-contextual-help/) ## Donar ¿Te gustaría apoyar el avance de este plugin? [ Donar para este plugin ](http://voceplatforms.com/)