PlaceholderApi

Services.get("PlaceholderApi")

Overview

parseString(player, input) ⇒ ItemStack
registerPlaceholder(prefix, handler)
unregisterPlaceholder(prefix)

API Reference

parseString()

PlaceholderAPI.parseString(player: Player, input: String): String

Parameters:

• player (Player): The player for whom the placeholder should be parsed.

• input (String): The string containing one or more placeholders (e.g., %placeholder% ).

Returns:

• String: A copy of the input string with all placeholders replaced with their actual values.

Example:

Example:

const PlaceholderAPI = Services.get("PlaceholderApi")
registerEvent("org.bukkit.event.player.PlayerJoinEvent", {
    handleEvent: function(event) {
        var player = event.getPlayer()
        var message = "Placeholder data: %placeholder%"
        var parsedMsg = PlaceholderAPI.parseString(player, message)
        player.sendMessage(parsedMsg)
    }
})

---

registerPlaceholder()

Method: PlaceholderAPI.registerPlaceholder(prefix, listener)

• prefix (String): The unique identifier for your placeholder. It will be used in the placeholder format %openjs_<prefix>_<params>%

• listener (Object): An object containing an onRequest(player, params) method, which will be called whenever the placeholder is parsed

Parameter: onRequest(player: Player, params: String): String

• player (Player) The player for whom the placeholder is being resolved. Can be null (e.g., if not run in a player context)

• params (String) The parameter string following your prefix in the placeholder. Can also be null.

Placeholder Syntax

%openjs_<prefix>_<params>%

• Example: %openjs_greetplr_to this server!%

  • Prefix: greetplr

  • Params: to this server!

Example (without parameters):

const PlaceholderAPI = Services.get("PlaceholderApi")

// Register a custom placeholder %openjs_greetplr_<params>%
PlaceholderAPI.registerPlaceholder("greetplr", {
    onRequest: function(player, params) {
        return "Welcome " + player.getName() + " " + params; // No params equals => ""
    }
});

registerEvent("org.bukkit.event.player.PlayerJoinEvent", {
    handleEvent: function(event) {
        var player = event.getPlayer();
        var rawMessage = "%openjs_greetplr% to this server!";
        var parsedMessage = PlaceholderAPI.parseString(player, rawMessage);
        player.sendMessage(parsedMessage); // → Welcome Steve to this server!
    }
});

Example (with paremeters):

const PlaceholderAPI = Services.get("PlaceholderApi")

// Register a custom placeholder %openjs_greetplr_<params>%
PlaceholderAPI.registerPlaceholder("greetplr", {
    onRequest: function(player, params) {
        return "Welcome " + player.getName() + " " + params;
    }
});

registerEvent("org.bukkit.event.player.PlayerJoinEvent", {
    handleEvent: function(event) {
        var player = event.getPlayer();
        var rawMessage = "%openjs_greetplr_to this server!%";
        var parsedMessage = PlaceholderAPI.parseString(player, rawMessage);
        player.sendMessage(parsedMessage); // → Welcome Steve to this server!
    }
});

---

unregisterPlaceholder()

PlaceholderAPI.unregisterPlaceholder(prefix: String)

Parameters:

• prefix (String): The unique identifier for your placeholder. It will be used in the placeholder format %openjs_<prefix>_<params>%

Example:

const PlaceholderAPI = Services.get("PlaceholderApi")

// Register a custom placeholder %openjs_greetplr_<params>%
PlaceholderAPI.registerPlaceholder("greetplr", {
    onRequest: function(player, params) {
        return "Welcome " + player.getName() + " " + params;
    }
});

// Removing the custom placeholder %openjs_greetplr_<params>%:
PlaceholderAPI.unregisterPlaceholder("greetplr")