The documentation is currently not complete. There are a lot of Actions & Filters that are not yet documented on the website. Please check the sourcecode for more.

Search the Docs

Basics

Quicklinks

Posts

Actions

Filters

Filters the promotion posttype before registration
Filters the department taxnonomy before registration
Filters the confomat posttype before registration
Add a Admin Notice if shop was not configured already
Filters the design posttype before registration
Filters the designtag taxnonomy before registration
Filters the designgroup taxnonomy before registration
Filters the product posttype before registration
Filters the productgroup taxnonomy before registration

Functions

Updates the Producttypes connected with an Department
Collects all Producttypes that are connected with the Department on the remote API
Collects all Producttypes that are connected with the Department on the remote API and returns their terms if they exist.
Get Promotion Manager instance
get all Promotion Locations
get a specified Promotion Location
Checks if Location is defined
Register Promotion locations in your theme.
Check if the promotion feature is enabled
Checks if a location has active promotions
Returns aktive promotions for location
Print Promotion for location if location is given, otherwise print default promotion
Translates some properties of ACF Fieldgroups
Retrieve a Departments Resource
Retrieve a Departments Resource
Retrieve a department term
Checks if a department term exists
Returns an HTML string of taxonomy 'sfw-department' terms associated with a post and given taxonomy. Terms are linked to their respective term listing pages.
Displays a string of linked 'sfw-department' terms for a post.
Retrieve the terms of the taxonomy 'sfw-department' that are attached to the post.
Display or retrieve the HTML list of Departments.
Retrieve list of departments that contain producttype
Creates an Department
Save way to define a constant that uses the plugins prefix.
Retrieve the main capability used to control access to the plugins admin.
Checks if the current user is allowed to change shop options.
Check if $id is likely a Spreadshirt Id.
Forces single values to be wrapped in an array
Echo a string depending on $number
Echo only if $value is not empty
Retrieve node from Json Object
Adds leading #
Removes leading #
Translates some properties of ACF Fields
get the measure node
Generate a HTML Table with Sizes and Measures
Echo a HTML Table with Sizes and Measures
Get the current sizeFitHint.
Echoes the current sizeFitHint.
Retrieve plugin root path.
Retrieve plugin dir.
Alias of sfw_dir
Retrieve the current plugin version.
Checks if this is the pro version of this plugin
Retrieve on of two values depending on plugin version
Includes a file
Stores vars inside the main class.
Save way to retrieve a constant that uses the plugins prefix.
Retrieve the Description of the producttype.
Echoes the Description of the producttype.
Return all Appearance Nodes
Search for Appearance with $appearance_id in ProductType Appearances
Search for Appearance Name with $appearance_id in ProductType Appearances
Retrieve the producttypes permalink
Echoes the producttypes permalink
Retrieve the number of articles which are associated to the current producttype
Echoes the labeled number of articles which are associated to the current producttype
Get all Sizes
Get a Size Loop
Iterate through Sizes. Use it like have_posts
Check if the Size Loop is runnig
Get the current Size
Get either the current Size or a specified size of the current ProductType
Get the Id of the current Size
Echoes the Id of the current Size
Get the first sizeId from productType Must be inside the Size Loop
Echo the first sizeId from productType Must be inside the Size Loop
Get the name of the current size
Echoes the name of the current size
Get a View Loop
Iterate through Views. Use it like have_posts
Check if the View Loop is runnig
Get the current View
Get either the current View or a specified view of the current ProductType
Get the Id of the current view
Echoes the Id of the current view
Get the Name of the current or specified View
Echoes the Name of the current or specified View
Retrieve Producttypes list
Check for producttype taxonomy archive
Retrieve the producttype Object
Retrieve the producttype Term
Retrieve all ProductType Terms
Retrieve the ID of the producttype in the Sfw Loop. This function tries to get the ID from a less lasting source first. e.g. we don't have to load the whole ProductType Data
Retrieve the producttype id
Retrieve the Name of the producttype.
Echoes the name of the producttype.
Retrieve the ShortDescription of the producttype.
Echoes the ShortDescription of the producttype.
Get the Id of the current Appearance
Echo the Id of the current Appearance
Get the Name of the current or specified Appearance
[sfw_appearance_name description]
Get the Icon Source Url of the current or specified Appearance
Echo the Icon Source Url of the current or specified Appearance
Get all Views
Check if the Appearance Loop is runnig
Get the current Appearance
Get either the current Appearance or a specified Appearance of the current ProductType
Retrieve a wp page id for dynamic page
Retrieve permalink for page
checks if page matches layout and if the layout is valid
Registers all assets, but does not enqueue any
Enqueues Script & CSS for the Admin
Enqueues Script & CSS for the Visitor
Enqueues Core Javascript
Prepare some basic configurations for use with javascript
Switches Script inclusion depending on SCRIPT_DEBUG constant
enqueue script after wp_enqueue_script was probably called already
Create a Term for an ProductType
Get all Appearances
Get a Appearance Loop
Iterate through Appearances. Use it like have_posts
Echoes the locale
Check if external page settings exists
Retrieve external page settings
Retrieve the HTML Code of an external page
Retrieves a Spreadshirt Help Page
Creates a div container arround a string
Registers a new dynamic page type
return dynamic page settings for post
Retrieve the main menu slug
Retrieve the main menu slug
Retrieve the posttype menu position
Retrieve the Parent Page Url
Add metabox to sfw admin page
Retrieve the shops locale
retrieve an Anchor Tag with API resource URL for ProductType
retrieve an Anchor Tag with API resource URL for PrintType
Get an Articles Platform Url
Get a ProductType Platform Url
retrieve an Anchor Tag with Article Platform Url
retrieve an Anchor Tag with ProductType Platform Url
Prints product uavailable message
Retrieve product customize button
Echoes product customize button
Retrieve a proxied Spreadshirt Api Resource Url
return Url to the Users Spreadshirt Platform
create an Anchor Tag
retrieve API resource URL for Article
retrieve API resource URL for Product
retrieve API resource URL for Design
retrieve API resource URL for ProductType
retrieve API resource URL for PrintType
retrieve an Anchor Tag with API resource URL for Article
retrieve an Anchor Tag with API resource URL for Product
retrieve an Anchor Tag with API resource URL for Design
echo some required hidden fields for basket Operations
Print Appearance Select
Print Size Select
Retrieve the default quantity
Echoes the default quantity
Retrieve the Continue Shopping Link
Retrieve a product unavailable message
Retrieve the Template Directory path
Retrieve the Template Directory Url
return full file path for template file, checks for special theme compatibility
checks if theme compatibility file exists
Include a Template File, return Output
Include a Template File
Checks if a integrated template has a higher priority than a choosen template
print opening orderform for article
print closing orderform tags
Prints add to basket button
Replaces currency pattern with given parameters
Retrieve the shops currency symbol
Retrieve the shops currency isocode
Retrieve the shops currency pattern
Displays the T-Shirt Designer
Retrieve post meta and generates confomat configuration
Retrieve country data
Retrieve the country id
Retrieve the decimalPoint
Retrieve the thousandsSeparator
Retrieve the shops length unit
Retrieve the shops length unitFactor
Formats a float number to length respecting the spreadshirt shops country settings
[sfw_measure_format description]
Retrieve the shops language data
Retrieve language id
Retrieve the curreny resource
Retieve currency id
Retrieve currency decimalCount
Check if a confomat id is specified and post exists and is published
Check if the currents page layout displays a confomat and matches the main confomats page id
Retieve the permalink for the confomat page.
Retrieve the customize link for the current design
Echoes the design customize link
retrieve the customize link for the current product
Echoes the product customize link
Retrieve the customize link for the current article
Echoes the article customize link
Retrieve the customize link for the current producttype
Echoes the customize link for the current producttype
Retrieve List of Confomat Params
Return Array of settings that will be used to create a confomat instance
Retrieve a Confomat Embed Code
Echoes the shop Top Level Domain e.g. .com
retrieve the Platform Tld
Echoes the Platform Tld
Generates the Shop Url
Generates a Url for Spreadshird Shop resources
Retrieve the Parent Page Url
Retrieve the Parent Page Url
Retieve the ID of the page which should display the tablomat app
get the current Shop ID
Validates the core shop data
automatically updates shop meta data that is currenty unavailable via api
Retrieve the host
Echoes the host
Retrieve the apikey
Retrieve the apisecret
retrieve the shop name, possibly equal to shop id
echoes the shop name, possibly equal to shop id
retrieve the shop Top Level Domain e.g. .com
Returns one of two values depending on the cvrrent host
Check if the Shop is configured
Create new Brand Term
Retrieve the current Brand Term
Retrieve the current brand name
Echoes the brand name
Retrieve the Name including important Brand Names of the current ProductType.
Echo the branded producttype name
Whether or not to show the current brand
Retrieve the current brand description
Echoes the current brand description
Retrieve the main Shop Data
Retrieve a Shop Id
Echo the Shop Id
Check if the current host is Spreadshirt.net
Check if the current host is Spreadshirt.com
Retrieve the current PrintType Object
Retrieve the current printtype Term
Retrieve the ID of the current printtype in the Sfw Loop. This function tries to get the ID from a less lasting source first. e.g. we don't have to load the whole printtype Data
Echoes the printtype id
Show printtype or not
Retrieve the Name of the current printtype.
Echoes the printtype name
Retrieve the Description of the current printtype.
Echoes the printtype description
Retrieve the printtypes permalink
Echoes the printtype permalink
Retrieve the number of articles which are associated to the current printtype
Retrieve the vat hint
Retrieve the vat hint span tag
Retrieve the shipping hint
Retrieve the shipping costs page url
Retrieve the shipping hint linked to the shipping page
Retrieve the price hint
Echoes the price hint
Format price respecting its currency settings
Retrieve price markup
Returns $number with as less digits after the decimal point as possible
Formats a float number, respecting the spreadshirt shops country and currency settings
Adds brand term to Article
Retieve the design image object
Retieve the product/article image object
Retieve the composition image object.
Retieve the ProductType image object.
Retieve the ProductType Detail image object.
Retieve the ProductType Size image object.
Retrieve the Appearance image object.
Retieve a Configuration image object.
Retrieve the last time a Sync was finished
Set the time for the last finished Synchronization to now
Check if a Synchronization was peformed within the given duration
Check if a Synchronization has ever happened
Sync multiple Entity Items
Synchronize an Item
Retrieve the timestamp when an Entity Item was synced the last time
Mark an item as synced
Checks if an Entity Items sync is expired and the entity should be synced again
Create a Term for an PrintType
Checks for printtype archive
Retrieve the number of articles which are associated to the current design
Helper for retrieving design count
Retrieve the labeled number of articles which are associated to the current design
Echoes the labeled number of articles which are associated to the current design
Retrieve the designs permalink by design id
Echoes the designs permalink by design id
Retrieve the url to all articles with a design in the Admin Screen
retrieve the url to all Articles with a Design in the Admin Screen
echoes the url to all Articles with a Design in the Admin Screen
Changes the main query to a designs articles
Ends design articles loop
Retrieve Design Children Posts
Removes a design as parent from its children designs
Allows filtering the [sfw] shorttag by attribute
Add a sub-shortcode like [sfw subname]
Helper for short images args
Parses image args
Get a Parent Design
This is a Helper for quickly getting the Parent of a Design if present or otherwise the Design itself
This is a Helper for quickly getting post of the parent of a Design if present or otherwise the designs post itself
Check if a Design has a Parent
Checks if a design probably has $children
checks if the current post in the Wordpress Loop is an design
Retrieve the name of the current design
Echoes the name of the current design
Retrieve the description of the current design
Echoes the description of the current design
Retrieve the backgroundcolor setting of the current design
Echoes the backgroundcolor setting of the current design
Checks if the design is mainly white
Retrieve the number of articles which are associated to the current design
Retrieve the number of articles which are associated to the current design
Retrieve the number of child designs which are associated to the current design
Echoes the designs articles count
syncs all designs assiciated with an article
Create a Post and Metadate for an Design
Retrieve the current Design Object from the global Sfw Object
Retrieve design id
Echoes design id
Retrieve a Design ID
Get the Wildcard Design Id
Retrieve a Post 'sfw-design' by $design_selector
Get a Designs Parent Id
Retrieve the Design Id of the configuration
Echoes the Design Id of the configuration
Retrive array with all of a products design ids
Retrive array with all of a products printtype ids
Create a Post and Metadate for an Article
Retrieve the current Product Object from the global Sfw Object
Retrieve the ID of the current Articles Product in the Sfw Loop
Echoes the product id
Retrieve the current article price
Retrieve an well formatted article price
Echoes article price
Check if the configuration Loop is runnig
Retrieve the configuration
Retrieve the configuration id
Get either the configuration or a specified configuration of the Product
Retrieve the Id of the configuration
Echoes the Id of the configuration
Retrieve the type of the configuration
Echoes the type of the configuration
Test the Type of the configuration
If the configuration is text
If the configuration is design
Retrieve the PrintType Id of the configuration
Echoes the PrintType Id of the configuration
Get the corresponding appearance node from the producttype object
Retrieve the current articles appearance name
Echo the current articles appearance name
Retrieve the article default View
Echoes the article default View
Test if a default design exists
Retrieve the article default design
Echo the article default design
Retrieve the article producttype id
echo the article producttype id
Get all configurations
Get a configuration Loop
Iterate through configurations. Use it like have_posts
Iterate through Views. Use it like have_posts
Check if the View Loop is runnig
Retrieve the design Id
Echoes the design Id
Checks if the current post is an Article
Retrieve the current Article
Retrieve article id
Echoes the article id
Retrieve a Wordpress Post by Spreadshirt Article Id
Retrieve the article title
Echoes the article title
Check if the title is something other than the Article Id or empty. This is usualy the case if it was modified
Retrieve the Name of the current Article in the Sfw Loop.
Echoes the article name fallback
Retrieve the default appearance id for the article
Echoes the default appearance id for the article
Add Spreadshirt Id to form edit screen
Create new Column for Spreadshirt Ids in Term WP list table
Fill Spreadshirt Id column in WP Term list table
Create new Column for Previews in Term WP list table
Hides the add new term form
Remove the meta_box for a taxonomy
sfw
Retrieve the main plugin instance
Check if debugging is enabled
Trigger an error at runtime.
Trigger Notice at runtime
Trigger an error at runtime.
Log Notice at runtime
Retrieve a design loop
Retrieve an Entity by a given posttype
Retrieve a Spreadshirt Id for a given Wordpress resource
Retrieve a Spreadshirt Id for a given Term
Retrieve a Spreadshirt Id for a given post
Extract Spreadshirt Id from Entity Item
Efficiently retrieve multiple Entity items
Prints Table row for the table in the term edit form
Retrieve multiple Entities
Try to get an Entity by args
Check if an Entity exists
Retrieve a Post or Term for given Entity and Spreadshirt ID
Retrieve WP_Post for given Entity and Spreadshirt ID
Retrieve WP_Term for given Entity and Spreadshirt ID
Checks if a Wordpress resource for given Entity and Spreadshirt ID exists
Checks if an item is valid for given Entity
Triggers creation of new Entity Item
Triggers update of new Entity Item
Alias of sfw_get_item
Alias of sfw_get_item
Returns property from SFW_Entity instance
Retrieve Entitys wp_type property
Retrieve Entitys wp_subtype property
Alias of sfw_get_entity_posttype
Alias of sfw_get_entity_posttype
Retrieve Entitys wp_metakey property
Retrieve an Entity by a given WP Resource like a post or term
Retrieve an Entity by a given Taxonomy
Check if the API Request is authorized
Wrapper for registering a new rest route in der sfw namespace
Check if string to itself after sanitization
Create a rest response
force leading slash
Sanitizes a Spreadshirt Id
Create a Preview Url for post from preview url in meta
Creates Preview img html
Echoes a preview image
Registers an Entity
Retrieve an Entity
Retrieve the SFW API namespace
Retrieve the SFW API namespaced url
Try to retrieve an Entity Item by a given value
try to guess an Entity Item by optional $value
tries to get Spreadshirt Id for Item
Retrieve meta of post or term
Retrieve the first term of taxonomy assocciated with a post
Checks if any terms of given taxonomy are tied to $post
adds a term to a post
Returns the Id for posts and terms
Schedules a new event if it does not already exist
Tries to get an Entity by the current Wordpress context
Retrieve a term id
Same as get_term_meta, but accepts WP_Term as first parameter
Retrieve a post id
Same as get_post_meta, but accepts WP_Post as first parameter
Updates meta of post or term
Retrieves any remote page and caches the result
Checks for WP_Term or WP_Post
Perform an remote GET request
Perform an remote POST request
Create relative request path
Create relative request path in the shops namespace
Requests and returns a cached api resource
Checks for a valid api response casted into an Object
Performs an Api request
Adds content after rendered field forms
Retrieve the global Spreadshirt Api object
Retriev a set of Args used to instantiate a WP_Spreadshirt_Api object
Retrieve the plugins User Agent for api requests
Adds basic data to all api requests if they do not exist already
Creates general WP_Error
Creates WP_Error
Adds backtrace information to WP_Error in Debugmode
Mark Spreadshirt Ids that will most likeley have to be be queried later
Loads primed entity items now
Checks if Metadata for Object is in the cache
Maybe cache spreadshirt ids of posts or terms
Returns Instructions marking options for developers and advanced users
Checks for the field group edit screen
If we can use acf pro functionality
Sets autoload to no
Shorthand for creating Instances of Spreadshirt_Image Class
Retrieve the proxy url
Converts given url to proxied url
Writes a message to the Log
Check if the current screen matches value
Adds post type admin table column with content
Adds taxonomy admin table column with content
Add Metabox
Retrieve the global ID Cache Instance
Set an ID relation

Classes

Controls SFW dynamic Pages
Handles registration of SFW_Admin Pages
SFW
The main Plugin core
This Class helps to iterate through api data in the style of the wordpress post loop
Control relation between Wordpress Resources and Spreadshirt Resources
Makes the Spreadshirt API available via WP Rest
Spreadshirt API Interface
This Class creates IMG-Tags for Spreadshirt Images. They support srcset and respect the possible Spreadshirt Imagesizes.
Manages registration of SFW Entities
Manages the caching of relations between Spreadshirt Ids and Wordpress Ids

Files