{
  "slug": "support",
  "name": "support",
  "version": "1.1.1",
  "source": {
    "repo": "support",
    "ref": "v1.1.1",
    "refType": "tag",
    "linkRef": "v1.1.1"
  },
  "docs": "/docs/support/hooks/",
  "hooks": [
    {
      "name": "mmwp_support_booted",
      "type": "action",
      "group": "Actions",
      "dynamic": false,
      "deprecated": false,
      "since": "1.0.0",
      "summary": "Fires after the winning copy of the package has booted.",
      "params": [
        {
          "name": "$version",
          "type": "string",
          "description": "Booted package version."
        },
        {
          "name": "$path",
          "type": "string",
          "description": "Directory of the booted copy."
        }
      ],
      "anchor": "/docs/support/hooks/#mmwp_support_booted",
      "source": "https://github.com/mammothwp/support/blob/v1.1.1/src/Kernel.php#L175"
    },
    {
      "name": "mmwp_support_action_link",
      "type": "filter",
      "group": "Filters",
      "dynamic": false,
      "deprecated": false,
      "since": "1.0.0",
      "summary": "Filters whether a plugin gets the \"Support\" action link.",
      "params": [
        {
          "name": "$enabled",
          "type": "bool",
          "description": "Default true."
        },
        {
          "name": "$slug",
          "type": "string",
          "description": "Plugin slug."
        }
      ],
      "anchor": "/docs/support/hooks/#mmwp_support_action_link",
      "source": "https://github.com/mammothwp/support/blob/v1.1.1/src/Config.php#L157"
    },
    {
      "name": "mmwp_support_attach_report",
      "type": "filter",
      "group": "Filters",
      "dynamic": false,
      "deprecated": false,
      "since": "1.0.0",
      "summary": "Filters whether `site-report-<host>-<date>.json` is attached to the email.",
      "params": [
        {
          "name": "$attach",
          "type": "bool",
          "description": "Default true."
        },
        {
          "name": "$slug",
          "type": "string",
          "description": "Plugin slug."
        }
      ],
      "anchor": "/docs/support/hooks/#mmwp_support_attach_report",
      "source": "https://github.com/mammothwp/support/blob/v1.1.1/src/Config.php#L118"
    },
    {
      "name": "mmwp_support_branding",
      "type": "filter",
      "group": "Filters",
      "dynamic": false,
      "deprecated": false,
      "since": "1.0.0",
      "summary": "Filters the resolved branding values (site-owner white-label; wins over everything).",
      "params": [
        {
          "name": "$values",
          "type": "array<string,mixed>",
          "description": "Resolved branding values."
        },
        {
          "name": "$mode",
          "type": "string",
          "description": "mammoth, neutral, vendor or whitelabel."
        }
      ],
      "anchor": "/docs/support/hooks/#mmwp_support_branding",
      "source": "https://github.com/mammothwp/support/blob/v1.1.1/src/Kernel.php#L243"
    },
    {
      "name": "mmwp_support_capability",
      "type": "filter",
      "group": "Filters",
      "dynamic": false,
      "deprecated": false,
      "since": "1.0.0",
      "summary": "Filters the capability required for the Support screen and operations.",
      "params": [
        {
          "name": "$capability",
          "type": "string",
          "description": "Capability, default `manage_options`."
        },
        {
          "name": "$network",
          "type": "bool",
          "description": "True for the network admin screen."
        }
      ],
      "anchor": "/docs/support/hooks/#mmwp_support_capability",
      "source": "https://github.com/mammothwp/support/blob/v1.1.1/src/Config.php#L65"
    },
    {
      "name": "mmwp_support_email",
      "type": "filter",
      "group": "Filters",
      "dynamic": false,
      "deprecated": false,
      "since": "1.0.0",
      "summary": "Filters the support recipient for a plugin. Wins over the constant, the array and the JSON file.",
      "params": [
        {
          "name": "$email",
          "type": "string",
          "description": "Resolved address so far."
        },
        {
          "name": "$slug",
          "type": "string",
          "description": "Plugin slug."
        }
      ],
      "anchor": "/docs/support/hooks/#mmwp_support_email",
      "source": "https://github.com/mammothwp/support/blob/v1.1.1/src/Plugin_Factory.php#L111"
    },
    {
      "name": "mmwp_support_menu",
      "type": "filter",
      "group": "Filters",
      "dynamic": false,
      "deprecated": false,
      "since": "1.0.0",
      "summary": "Filters the canonical Support screen location. Wins over the constant and the default.",
      "params": [
        {
          "name": "$location",
          "type": "string|null",
          "description": "Null (no override) or toplevel|tools|settings|hidden|parent:<menu-slug>."
        },
        {
          "name": "$default",
          "type": "string",
          "description": "The location the package would use without an override."
        }
      ],
      "anchor": "/docs/support/hooks/#mmwp_support_menu",
      "source": "https://github.com/mammothwp/support/blob/v1.1.1/src/Kernel.php#L211"
    },
    {
      "name": "mmwp_support_menu_icon",
      "type": "filter",
      "group": "Filters",
      "dynamic": false,
      "deprecated": false,
      "since": "1.0.1",
      "summary": "Filters the Mammoth WP menu icon (SVG data URI or dashicon name).",
      "params": [
        {
          "name": "$icon",
          "type": "string",
          "description": "Data URI or dashicon name."
        }
      ],
      "anchor": "/docs/support/hooks/#mmwp_support_menu_icon",
      "source": "https://github.com/mammothwp/support/blob/v1.1.1/src/Kernel.php#L272"
    },
    {
      "name": "mmwp_support_menu_position",
      "type": "filter",
      "group": "Filters",
      "dynamic": false,
      "deprecated": false,
      "since": "1.0.0",
      "summary": "Filters the position of the top-level menu.",
      "params": [
        {
          "name": "$position",
          "type": "int",
          "description": "Default 80."
        }
      ],
      "anchor": "/docs/support/hooks/#mmwp_support_menu_position",
      "source": "https://github.com/mammothwp/support/blob/v1.1.1/src/Config.php#L136"
    },
    {
      "name": "mmwp_support_rate_limit",
      "type": "filter",
      "group": "Filters",
      "dynamic": false,
      "deprecated": false,
      "since": "1.0.0",
      "summary": "Filters the send rate limit (per user).",
      "params": [
        {
          "name": "$limit",
          "type": "array{max:int,window:int}",
          "description": "Max sends and window in seconds."
        },
        {
          "name": "$user_id",
          "type": "int",
          "description": "User id."
        }
      ],
      "anchor": "/docs/support/hooks/#mmwp_support_rate_limit",
      "source": "https://github.com/mammothwp/support/blob/v1.1.1/src/Config.php#L91"
    },
    {
      "name": "mmwp_support_report_sections",
      "type": "filter",
      "group": "Filters",
      "dynamic": false,
      "deprecated": false,
      "since": "1.0.0",
      "summary": "Filters the report sections. Add a `Section_Interface` object. Contract: no secrets; redaction runs over everything, but do not rely on it.",
      "params": [
        {
          "name": "$sections",
          "type": "Section_Interface[]",
          "description": "Sections in output order."
        }
      ],
      "anchor": "/docs/support/hooks/#mmwp_support_report_sections",
      "source": "https://github.com/mammothwp/support/blob/v1.1.1/src/Report/Report_Builder.php#L112"
    },
    {
      "name": "mmwp_support_subject",
      "type": "filter",
      "group": "Filters",
      "dynamic": false,
      "deprecated": false,
      "since": "1.0.0",
      "summary": "Filters the email subject.",
      "params": [
        {
          "name": "$text",
          "type": "string",
          "description": "Formatted subject."
        },
        {
          "name": "$prefix",
          "type": "string",
          "description": "Subject prefix from branding."
        },
        {
          "name": "$slug",
          "type": "string",
          "description": "Plugin slug."
        },
        {
          "name": "$subject",
          "type": "string",
          "description": "User-entered subject."
        },
        {
          "name": "$ref",
          "type": "string",
          "description": "Reference."
        }
      ],
      "anchor": "/docs/support/hooks/#mmwp_support_subject",
      "source": "https://github.com/mammothwp/support/blob/v1.1.1/src/Mail/Ticket_Formatter.php#L74"
    },
    {
      "name": "mmwp_support_transport",
      "type": "filter",
      "group": "Filters",
      "dynamic": false,
      "deprecated": false,
      "since": "1.0.0",
      "summary": "Filters the mail transport. Only MailTransport (wp_mail) ships. Any transport that sends data off-site needs the same explicit user action as the built-in one.",
      "params": [
        {
          "name": "$transport",
          "type": "Transport_Interface",
          "description": "Transport."
        }
      ],
      "anchor": "/docs/support/hooks/#mmwp_support_transport",
      "source": "https://github.com/mammothwp/support/blob/v1.1.1/src/Kernel.php#L359"
    }
  ]
}