caphun

<p>Use the Contextual Pages widget to add pages at a target depth as a widget.</p>
<p>This similar to the Pages widget except you can choose a depth and the list pages automatically confines to the current hierarchical context.</p>


Contextual Pages Widget

The Contextual Pages Widget allows you to display pages in a target depth within the…

Kevin Langley Jr.

<p>Adds helper functionality to easily add to the WP Contextual Help throughout the admin of a WordPress site.</p>
<h4>Usage</h4>
<p>When you register a tab you have a few different options as far as what content is displayed there.</p>
<p>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.</p>
<p>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.</p>
<p>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 <code>post-management</code> it would look for <code>post-management.html</code> within the help docs directory.</p>
<h4>HTML Help Docs</h4>
<p>All help docs should either reside within the <code>get_template_directory() . '/includes/help-docs/';</code> directory and all images within the <code>get_template_directory() . '/includes/help-docs/img/';</code></p>
<p>You can use the <code>wp_contextual_help_docs_dir</code> filter to change the directory for the HTML files and the <code>wp_contextual_help_docs_url</code> filter to change the base URL for the images. Within your help documentation we use the variable <code>{WP_HELP_IMG_URL}</code> 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.</p>
<h4>Registering a tab</h4>
<p>Help tabs are registered using the <code>WP_Contextual_Help::register_tab()</code> method.</p>
<p><strong>Parameters</strong></p>
<ul>
<li><code>$id</code> (string) – String to be used as the ID for the help tab</li>
<li><code>$title</code> (string) – Title to display to the user within the tab</li>
<li><code>$args</code> (array) – An array of options for the help tab
<ul>
<li><code>page</code> (string, array) – Page(s) to enable the help tab</li>
<li><code>post_type</code> (string, array) – Limit the tab to only display on these specific post types</li>
<li><code>file</code> (string) – HTML file to read and output within the tab</li>
<li><code>wpautop</code> (boolean) – Default: False – Apply wpautop to the loaded HTML file</li>
<li><code>callback</code> – If a user would rather a custom callback instead of the autoloading of a HTML file, this is where that would be applied</li>
</ul>
</li>
</ul>
<h4>Example</h4>
<pre><code><?php  add_action( 'init', function(){      if( !class_exists( 'WP_Contextual_Help' ) )         return;      // Only display on the pages - post.php and post-new.php, but only on the post post_type     // This would automatically look for a file called post-management.html within get_template_directory() . '/includes/help-docs/';     WP_Contextual_Help::register_tab( 'post-management', 'Post Management', array(         'page' => 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 '<p>It is super easy to add new help tabs!</p>';         }     ) ); } ); ?> </code></pre>


WP Contextual Help

Allows a developer to easily extend the contextual help dropdown content area in WordPress.

Contextual Pages Widget vs WP Contextual Help