WordPress.org

Make WordPress Core

Ticket #48395: 48395.diff

File 48395.diff, 1.4 KB (added by atachibana, 20 months ago)
  • class-wp-screen.php

     
    594594
    595595        /**
    596596         * Add a help tab to the contextual help for the screen.
    597          * Call this on the load-$pagenow hook for the relevant screen.
    598597         *
     598         * Call this on the load-$pagenow hook for the relevant screen,
     599         * or fetch the $current_screen object or use get_current_screen()
     600         * and then call the method from the object.
     601         *
     602         * You may need to filter $current_screen using an if or switch statement
     603         * to prevent new help tabs from being added to ALL admin screens.
     604         *
    599605         * @since 3.3.0
    600606         * @since 4.4.0 The `$priority` argument was added.
    601607         *
     
    603609         *     Array of arguments used to display the help tab.
    604610         *
    605611         *     @type string $title    Title for the tab. Default false.
    606          *     @type string $id       Tab ID. Must be HTML-safe. Default false.
     612         *     @type string $id       Tab ID. Must be HTML-safe and should be unique for this menu. It is NOT allowed to contain any empty spaces. Default false.
    607613         *     @type string $content  Optional. Help tab content in plain text or HTML. Default empty string.
    608614         *     @type string $callback Optional. A callback to generate the tab content. Default false.
    609615         *     @type int    $priority Optional. The priority of the tab, used for ordering. Default 10.