🔍 Placeholders

Phoenix Shop supports PlaceholderAPI, allowing you to use placeholders from other plugins inside the shop. Below is where PlaceholderAPI placeholders are read, as well as our internal placeholders that you can use in commands, menus and signs.

#PlaceholderAPI

The plugin registers the placeholders below. The AutoSell and Rotating Shop add-ons register their own, listed on their pages.

PlaceholderAPI placeholders are resolved for the player in:

• Purchase commands and sell commands.
• The input and output of a requirement. ⭐
• The balance of a Placeholder currency. ⭐

<shop>, <category> and <item> are identifiers, not display names, in any case. Separate them with :. An item is looked up in every category of the shop. A placeholder naming something that does not exist is left as it is.

#Sales ⭐

Placeholder	Description
%phoenixshop_sale_<shop>%	The percent off of the shop-wide sale running now. 0 without one.
%phoenixshop_sale_<shop>:<category>%	The percent off the category gets now: its own sale, or the shop-wide one.
%phoenixshop_sale_active_<shop>%, %phoenixshop_sale_active_<shop>:<category>%	true while that sale runs, otherwise false.
%phoenixshop_sale_ends_<shop>%, %phoenixshop_sale_ends_<shop>:<category>%	The time until the running sale stops: its end date, the end of its time window or the end of its last day, whichever comes first. - when no sale runs, Never when it has no end.
%phoenixshop_sale_ends_<shop>_seconds%, %phoenixshop_sale_ends_<shop>:<category>_seconds%	The same in seconds. 0 when no sale runs, -1 when it has no end.

#Items

Placeholder	Description
%phoenixshop_buy_<shop>:<item>%	The price the player pays for one purchase now, as the category menu shows it. - when the item cannot be bought.
%phoenixshop_sell_<shop>:<item>%	The price the player gets for one sale now. - when the item cannot be sold.
%phoenixshop_buy_<shop>:<item>_raw%, %phoenixshop_sell_<shop>:<item>_raw%	The same price as a plain number. -1 when it cannot be bought or sold.
%phoenixshop_stock_<shop>:<item>%	The stock left, or Unlimited. ⭐
%phoenixshop_restock_<shop>:<item>%	The time until the item restocks. - when no restock is due. ⭐
%phoenixshop_restock_<shop>:<item>_seconds%	The same in seconds, -1 when no restock is due. ⭐
%phoenixshop_limit_<shop>:<item>%	How many more the player can buy before their purchase limit. Unlimited without a limit, - while the player is offline. ⭐

#Player Shops

Placeholder	Description
%phoenixshop_playershops%	How many player shops the player owns.
%phoenixshop_playershops_limit%	How many they can own, or Unlimited. Limit permissions only count while the player is online.
%phoenixshop_playershops_left%	How many more they can create.

#Player Stats ⭐

Counted from the purchase history: shops and admin sign shops, without player shop trades or undone transactions. They refresh about once a minute and show 0 until the first load.

Placeholder	Description
%phoenixshop_spent%, %phoenixshop_spent_<shop>%	The money spent, per currency, separated by commas.
%phoenixshop_earned%, %phoenixshop_earned_<shop>%	The money earned, per currency.
%phoenixshop_bought%, %phoenixshop_bought_<shop>%	The number of items bought.
%phoenixshop_sold%, %phoenixshop_sold_<shop>%	The number of items sold.
%phoenixshop_transactions%, %phoenixshop_transactions_<shop>%	The number of transactions.

#Leaderboards ⭐

The top 10 players, counted like the player stats. <stat> is spent, earned, bought, sold or transactions, and <n> is a place from 1 to 10. Add a shop before the place for that shop's board. A shop id may contain _, since the place is read from the end. Boards load the first time they are asked for, refresh every 5 minutes and stay empty until the first load.

Money boards rank one currency: money server-wide, the shop's own currency for a shop board. Trades in other currencies do not count there.

Placeholder	Description
%phoenixshop_top_<stat>_<n>_name%, %phoenixshop_top_<stat>_<shop>_<n>_name%	The name of the player in that place. - when nobody holds it yet.
%phoenixshop_top_<stat>_<n>_value%, %phoenixshop_top_<stat>_<shop>_<n>_value%	Their total, in the ranked currency for spent and earned, a plain number otherwise. - when nobody holds the place.
%phoenixshop_top_<stat>_position%, %phoenixshop_top_<stat>_<shop>_position%	The player's own place on that board, - without any trade counted.

For example %phoenixshop_top_spent_1_name% or %phoenixshop_top_sold_ore_shop_3_value%.

#Command Placeholders

Available in an item's purchase commands and sell commands.

Placeholders	Description
%player%	The name of the player.
%amount%	The number of times the item was bought or sold.
%item%	The name of the item.
%price%	The total price paid or earned.
%currency%	The name of the currency.
%shop%	The name of the shop.

#Placeholder Currency ⭐

Available in the buy and sell commands of a Placeholder currency, which always run from the console.

Placeholders	Description
%player%	The name of the player.
%amount%	The amount to take or give.
%amount_int%	The amount to take or give, rounded up to a whole number.

#Menu Placeholders

Available in the titles, names and lore of the shop menus. Every %shop%, %category% and %item% has a _colored version that keeps the colors, such as %shop_colored%.

Placeholders	Menus	Description
%shop%	Every menu	The name of the shop.
%category%	Category	The name of the category.
%player%	Category	The name of the player.
%item%	Buy, Sell, Bulk Buy, Bulk Sell	The name of the item.
%amount%	Buy, Sell	The number of items selected.
%lots%	Buy, Sell	The number of times the item is selected.
%max%	Buy, Sell	The most items the player can buy or sell.
%unit_price%	Buy, Sell	The price of one.
%price%	Buy, Sell	The price of the selected amount.
%max_price%	Buy, Sell	The price of the most the player can buy or sell.
%balance%	Buy, Sell	The balance of the player in the item's currency.
%stock%	Buy, Sell	The stock left of the item. ⭐
%buy_price_base%, %sell_price_base%	Category, Search	The price before any price modifier. ⭐
%price_base%, %unit_price_base%	Buy, Sell	The price before any price modifier. ⭐
%price_base%	Bulk Buy, Bulk Sell	The price before any price modifier. ⭐
%sale%	Main, Category	The category sale badge while the sale runs, empty otherwise. ⭐
%sale_ends%	Main	A line with the time left on the sale, counting down every second. Left out while no sale with an end is running. ⭐
%category_lore%	Main	The category's lore, or its icon item's lore when none is set. One line of the template per lore line.
%count%, %price%	Preview	How many items one purchase gives, and its price. ⭐

#Message Placeholders

Available in the messages sent after a transaction.

Placeholders	Description
%amount%	The number of items bought or sold.
%item%	The name of the item.
%price%	The total price paid or earned.
%currency%	The name of the currency.
%balance%	The balance of the player after the transaction.

#Sign Shop Placeholders ⭐

Available in the lines of an admin sign shop.

Placeholders	Description
%id%	The identifier of the sign.
%name%	The name of the sign.
%shop%	The name of the shop.
%category%	The name of the category.
%item%	The name of the item.
%amount%	The number of items per click.
%stock%	The stock left of the item.
%buy_price%	The buy price per click.
%sell_price%	The sell price per click.
%mode%	Whether the sign buys, sells or both.