WordPress中创建新简码的实用程序包。

1.02 2021-11-22 17:35 UTC

This package is auto-updated.

Last update: 2024-09-23 00:12:47 UTC


README

安装

在您的 composer.json 中包含 composer 包 marspress/short-code,最低版本为 dev-main,或者运行 composer require marspress/short-code

使用

new \MarsPress\ShortCode\Tag() 接受 4 个参数,其中 2 个是必需的,2 个是可选的。

  • 标签名称(必需)(字符串)
    • 在 WordPress 中使用的标签名称。例如,output_user_info 将如下使用: [output_user_info]
    • 如果标签已被使用,它将不会注册该标签,并向管理员输出有关重复标签名称的提示。
  • 回调(必需)(可调用的)
    • 可调用的方法。这可以是闭包函数或数组,其中包含类方法,如下所示:[ $this, '<method name>' ](非静态) 或 [ __CLASS__, '<method name>' ](静态)
    • 如果回调不可调用,则将向管理员输出消息,而不是输出简码。
    • 重要:您的回调将传递 3 个参数
      • 属性(对象)
        • 这将是解析后的属性,结合默认属性和简码中定义的属性。
      • 内容(字符串)
        • 这是简码标签内的内容。当使用开标签和闭标签时,例如 [user_logged_in]User can see this![/user_logged_in],这被使用。
        • 通常,您还应该在返回之前在内容参数上调用 do_shortcode,以防内容中还有更多的简码。
      • 标签名称(字符串)
        • 正在使用的标签名称。
  • 默认属性(可选)(数组)
    • 一个关联数组,用于在您的回调中合并后可用的默认简码属性。
    • 默认为空数组。
  • 覆盖(布尔值)
    • 是否覆盖现有的标签名称。
    • 默认为 false。