Docs: Correct and improve inline docs for parameters that accept a callback function.

See #49572

git-svn-id: https://develop.svn.wordpress.org/trunk@48473 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2020-07-14 11:54:26 +00:00
parent 585f623b4d
commit fa9e258750
10 changed files with 60 additions and 60 deletions

View File

@@ -4778,11 +4778,11 @@ function wp_ajax_wp_privacy_export_personal_data() {
* @type array {
* Array of personal data exporters.
*
* @type string $callback Callable exporter function that accepts an
* email address and a page and returns an array
* of name => value pairs of personal data.
* @type string $exporter_friendly_name Translated user facing friendly name for the
* exporter.
* @type callable $callback Callable exporter function that accepts an
* email address and a page and returns an array
* of name => value pairs of personal data.
* @type string $exporter_friendly_name Translated user facing friendly name for the
* exporter.
* }
* }
*/
@@ -4968,12 +4968,12 @@ function wp_ajax_wp_privacy_erase_personal_data() {
* @type array {
* Array of personal data exporters.
*
* @type string $callback Callable eraser that accepts an email address and
* a page and returns an array with boolean values for
* whether items were removed or retained and any messages
* from the eraser, as well as if additional pages are
* available.
* @type string $exporter_friendly_name Translated user facing friendly name for the eraser.
* @type callable $callback Callable eraser that accepts an email address and
* a page and returns an array with boolean values for
* whether items were removed or retained and any messages
* from the eraser, as well as if additional pages are
* available.
* @type string $exporter_friendly_name Translated user facing friendly name for the eraser.
* }
* }
*/

View File

@@ -620,12 +620,12 @@ final class WP_Screen {
* @param array $args {
* Array of arguments used to display the help tab.
*
* @type string $title Title for the tab. Default false.
* @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.
* @type string $content Optional. Help tab content in plain text or HTML. Default empty string.
* @type string $callback Optional. A callback to generate the tab content. Default false.
* @type int $priority Optional. The priority of the tab, used for ordering. Default 10.
* @type string $title Title for the tab. Default false.
* @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.
* @type string $content Optional. Help tab content in plain text or HTML. Default empty string.
* @type callable $callback Optional. A callback to generate the tab content. Default false.
* @type int $priority Optional. The priority of the tab, used for ordering. Default 10.
* }
*/
public function add_help_tab( $args ) {

View File

@@ -147,7 +147,7 @@ class WP_Site_Health {
*
* @since 5.4.0
*
* @param $callback
* @param callable $callback
* @return mixed|void
*/
private function perform_test( $callback ) {

View File

@@ -332,7 +332,7 @@ function wp_nav_menu_item_link_meta_box() {
*
* @type string $id Meta box 'id' attribute.
* @type string $title Meta box title.
* @type string $callback Meta box display callback.
* @type callable $callback Meta box display callback.
* @type WP_Post_Type $args Extra meta box arguments (the post type object for this meta box).
* }
*/
@@ -684,10 +684,10 @@ function wp_nav_menu_item_post_type_meta_box( $object, $box ) {
* @param array $box {
* Taxonomy menu item meta box arguments.
*
* @type string $id Meta box 'id' attribute.
* @type string $title Meta box title.
* @type string $callback Meta box display callback.
* @type object $args Extra meta box arguments (the taxonomy object for this meta box).
* @type string $id Meta box 'id' attribute.
* @type string $title Meta box title.
* @type callable $callback Meta box display callback.
* @type object $args Extra meta box arguments (the taxonomy object for this meta box).
* }
*/
function wp_nav_menu_item_taxonomy_meta_box( $object, $box ) {