This is an automatically generated documentation for Documentation.

Namespaces

\App\Application

Classes

Class Description
Devflow

\App\Application\Console

Classes

Class Description
Kernel

\App\Application\Console\Commands

Classes

\App\Domain\Content

Classes

Class Description
Content
ContentError

\App\Domain\ContentType

Classes

Class Description
ContentType
ContentTypeError

\App\Domain\ContentType\Command

Classes

\App\Domain\ContentType\Dto

Classes

\App\Domain\ContentType\Event

Classes

\App\Domain\ContentType\Model

Classes

Class Description
ContentType

\App\Domain\ContentType\Query

Classes

\App\Domain\ContentType\Query\Trait

Traits

Trait Description
PopulateContentTypeQueryAware

\App\Domain\ContentType\Repository

Interfaces

\App\Domain\ContentType\Services

Interfaces

Interface Description
ContentTypeProjection

\App\Domain\ContentType\Validator

Classes

\App\Domain\ContentType\ValueObject

Classes

Class Description
ContentTypeId

\App\Domain\Content\Command

Classes

\App\Domain\Content\Dto

Classes

\App\Domain\Content\Event

Classes

\App\Domain\Content\Model

Classes

Class Description
Content

\App\Domain\Content\Query

Classes

\App\Domain\Content\Query\Trait

Traits

Trait Description
PopulateContentQueryAware

\App\Domain\Content\Repository

Interfaces

\App\Domain\Content\Services

Interfaces

Interface Description
ContentCache
ContentProjection

\App\Domain\Content\Validator

Classes

\App\Domain\Content\ValueObject

Classes

Class Description
ContentId

\App\Domain\Product

Classes

Class Description
Product
ProductError

\App\Domain\Product\Command

Classes

\App\Domain\Product\Dto

Classes

\App\Domain\Product\Event

Classes

\App\Domain\Product\Model

Classes

Class Description
Product

\App\Domain\Product\Query

Classes

\App\Domain\Product\Query\Trait

Traits

Trait Description
PopulateProductQueryAware

\App\Domain\Product\Repository

Interfaces

\App\Domain\Product\Service

Interfaces

Interface Description
ProductCache
ProductProjection

\App\Domain\Product\Validator

Classes

\App\Domain\Product\ValueObject

Classes

Class Description
ProductId

\App\Domain\Site

Classes

Class Description
SiteError

\App\Domain\Site\Command

Classes

\App\Domain\Site\Model

Classes

Class Description
Site

\App\Domain\Site\Query

Classes

\App\Domain\Site\Query\Trait

Traits

Trait Description
PopulateSiteQueryAware

\App\Domain\Site\Repository

Interfaces

\App\Domain\Site\Services

Interfaces

Interface Description
SiteCache

\App\Domain\Site\ValueObject

Classes

Class Description
SiteId

\App\Domain\User

Classes

Class Description
UserError

\App\Domain\User\Command

Classes

\App\Domain\User\Model

Classes

Class Description
User

\App\Domain\User\Query

Classes

\App\Domain\User\Query\Trait

Traits

Trait Description
PopulateUserQueryAware

\App\Domain\User\Repository

Interfaces

\App\Domain\User\Services

Interfaces

Interface Description
UserCache

\App\Domain\User\ValueObject

Classes

Class Description
UserId
Username
UserRole
UserToken

\App\Infrastructure\Errors

Classes

Class Description
HttpRequestError

\App\Infrastructure\Http\Controllers

Classes

\App\Infrastructure\Http\Middleware

Classes

Class Description
UserAuthMiddleware

\App\Infrastructure\Persistence

Classes

\App\Infrastructure\Persistence\Cache

Classes

\App\Infrastructure\Persistence\Projection

Classes

\App\Infrastructure\Persistence\Repository

Classes

\App\Infrastructure\Persistence\Trait

Traits

Trait Description
EventSourcedRepositoryAware

\App\Infrastructure\Providers

Classes

\App\Infrastructure\Services

Classes

Interfaces

Interface Description
Extension

\App\Infrastructure\Services\Attribute

Classes

Interfaces

Interface Description
AttributeRepository

\App\Infrastructure\Services\Content

Classes

Class Description
ContentService

\App\Infrastructure\Services\ContentType

Classes

Class Description
ContentTypeService

\App\Infrastructure\Services\ContentType\Event

Classes

\App\Infrastructure\Services\Content\Event

Classes

\App\Infrastructure\Services\Content\Pipes

Classes

\App\Infrastructure\Services\Product

Classes

Class Description
ProductService

\App\Infrastructure\Services\Product\Event

Classes

\App\Infrastructure\Services\Product\Pipes

Classes

Class Description
UniqueProductSlug

\App\Infrastructure\Services\Queue

Classes

\App\Infrastructure\Services\Site

Classes

Class Description
SiteSchema

\App\Infrastructure\Services\Trait

Traits

Trait Description
CleanAware

\App\Infrastructure\Services\User

Classes

Interfaces

Interface Description
UserAttributeRepository

\App\Infrastructure\Services\Vihzhuo

Classes

\App\Shared\Helpers

Functions

Function Description
get_roles()
current_user_can() Checks if current user has specified permission or not.
is_user_logged_in() Checks if a visitor is logged in or not.
ae() Checks if logged-in user can access menu, tab, or screen.
cms_authenticate() Logs a user in after the login information has checked out.
cms_authenticate_user() Checks a user's login information.
cms_set_auth_cookie() Sets auth cookie.
cms_clear_auth_cookie() Removes all cookies associated with authentication.
login_form_show_message() Shows error messages on login form.
get_secure_cookie_data() Retrieves data from a secure cookie.
get_user_roles()
get_content_type_by() Retrieve content type by a given field from the content_type table.
get_content_type_title() A function which retrieves a content type title.
get_content_type_slug() A function which retrieves a content_type slug.
get_content_type_description() A function which retrieves a content_type description.
get_content_type_permalink() A function which retrieves a content_type's permalink.
cms_unique_content_type_slug() Creates a unique content_type slug.
cms_insert_content_type() Insert or update a content_type.
cms_update_content_type() Update a Content Type in the content_type table.
cms_delete_content_type() Deletes a content_type from the content_type document.
get_all_content_types() Returns all content types.
get_content() Retrieve all the content regardless of status.
get_all_content_with_filters() Retrieve all content or content based on filters.
get_content_by_type_and_id() Retrieves content by content type slug and content id.
get_content_by() Retrieve content by a given field from the content table.
get_content_by_id() Retrieve content by the content id.
get_content_datetime() A function which retrieves content datetime.
get_content_modified() A function which retrieves content modified datetime.
get_content_body() A function which retrieves a content body.
get_content_contenttype_name() A function which retrieves a content content_type name.
get_content_contenttype_link() A function which retrieves a content content_type link.
get_content_title() A function which retrieves a content title.
get_content_slug() A function which retrieves a content slug.
get_content_relative_url() A function which retrieves a content's relative url.
get_permalink() A function which retrieves a content's permalink.
get_all_content() Wrapper function for get_all_content_with_filters.
content_status_label() Adds label to content's status.
get_content_attribute() Retrieve content attribute field for a content.
update_content_attribute() Update content attribute field based on content ID.
add_content_attribute() Add attribute data field to a content.
delete_content_attribute() Remove attribute matching criteria from a content.
get_content_author_id() A function which retrieves a content author id.
get_content_author() A function which retrieves a content author.
get_content_status() A function which retrieves a content status.
get_content_date() A function which retrieves content date.
get_content_time() A function which retrieves content time.
get_content_created_date() Retrieves content created date.
the_created_date() Retrieves content created date.
get_content_created_time() A function which retrieves content created time.
the_created_time() Retrieves content created time.
get_content_published_date() A function which retrieves content published date.
the_published_date() Retrieves content published date.
get_content_published_time() A function which retrieves content published time.
the_published_time() Retrieves content published time.
get_content_modified_date() A function which retrieves content modified date.
the_modified_date() Retrieves content published date.
get_content_modified_time() A function which retrieves content modified time.
the_modified_time() Retrieves content modified time.
get_content_content_type_id() A function which retrieves content content_type id.
get_content_contenttype() A function which retrieves content content_type.
get_content_parent_id() A function which retrieves a content's parent id.
get_content_parent() A function which retrieves content parent.
get_content_sidebar() A function which retrieves content sidebar.
get_content_show_in_menu() A function which retrieves content show in menu.
get_content_show_in_search() A function which retrieves content show in search.
cms_unique_content_slug() Creates a unique content slug.
number_content_by_type() Returns the number of content rows within a given content type.
get_content_parent_dropdown_list() Retrieves all posts
get_content_class() Retrieves an array of CSS class names.
the_permalink() Displays the permalink for the current content.
the_body() The cms content filter.
the_attribute() Retrieves and displays content attribute value.
the_title() Retrieves and displays content title.
publish_scheduled_content()
make_clickable() Turn all URLs into clickable links.
remote_file_exists() Checks if a remote file exists.
get_file_size()
checked() Outputs the HTML checked attribute.
selected() Outputs the HTML selected attribute.
disabled() Outputs the html disabled attribute.
checked_selected_helper() Private helper function for checked, selected, and disabled.
seconds_to_minutes()
is_ssl() Determines if SSL is used.
normalize_path() Normalize a filesystem path.
beautify_filename() Beautifies a filename for use.
sanitize_filename() Sanitizes a filename.
get_functions() Returns an array of function names in a file.
is_duplicate_function() Checks a given file for any duplicated named user functions.
check_includes() Performs a check within a php script and returns any other files
that might have been required or included.
check_syntax() Performs a syntax and error check of a given PHP script.
rmdir__() Removes directory recursively along with any files.
generate_timezone_list() Prints a list of timezones which includes
current time.
get_age() Get age by birthdate.
generate_unique_key() Generates a unique key.
convert_date_to_gmt() Converts date to GMT format.
convert_seconds_to_time() Converts seconds to time format.
set_email_template() Add the template to the message body.
replace_template_vars() Replace variables in the template.
process_email_html() Process the HTML version of the text.
get_domain_name() Retrieve the domain name.
cms_enqueue_css() Enqueues stylesheets.
cms_enqueue_js() Enqueues javascript.
generate_random_username() Generates a random username.
generate_random_password() Generates a random password drawn from the defined set of characters.
get_current_screen() Get the current screen.
_cms_image_optimizer() Image optimizer.
sort_list() Sort array of objects by field.
site_path() Site path.
encrypt() Encrypt function.
decrypt() Decrypt function.
maybe_serialize() Serializes data if necessary.
maybe_unserialize() Unserializes data if necessary.
is_serialized() Checks if data is serialized.
set_registry_entry() Sets a registry parameter.
get_registry_entry() Finds an entry of the registry by its identifier and returns it.
current_screen()
is_multisite() Whether multisite is enabled.
time_ago() Prints elapsed time based on datetime.
updater_server_url()
show_update_message()
dfdb() Global database function.
option() Return Options instance.
get_option()
update_option()
delete_option()
get_object_subtype() Returns the object subtype for a given array ID of a specific type.
cms_slugify() Creates unique slug based on string.
tinymce_link_list() Returns a list of internal links for TinyMCE.
if_content_type_slug_exists() Checks if a slug exists among records from the content type table.
if_content_slug_exists() Checks if a slug exists among records from the content table.
if_site_slug_exists() Checks if a site slug exists.
if_product_slug_exists() Checks if a product slug exists.
is_content_parent() Checks if content has any children.
if_content_type_exists() Checks if a given content type exists on content.
reassign_content() Reassigns content to a different user.
reassign_sites() Reassigns sites to a different user.
if_user_has_sites() Checks if the requested user is an admin of any sites or has any admin roles.
get_owner_sites() Get an array of sites by owner.
populate_options_cache() Populate the option cache.
collection() Creates a new collection.
generate_site_key() A private function for generating unique site key.
has_site_user_record()
unassigned_sites()
get_super_admins() Retrieve a list of super admins from site_user.
is_super_admin() Checks whether a user is a super admin.
cms_dropdown_languages() Retrieves a list of available locales.
load_devflow_textdomain() Load's core, themes, and plugins translated strings.
load_core_locale() Loads the current or default locale.
has_filter() Checks if a filter exists.
sanitize_meta() Sanitize meta value.
cms_release_value() Prints release value.
get_logo_large() Large logo. Filterable.
get_logo_mini() Mini logo. Filterable.
public_site_url() Returns full base url of a site's public url.
public_site_upload_url() Returns full base url of a site's public upload url.
cms_encode_email() Searches for plain email addresses in given $string and
encodes them (by default) with the help of cms_encode_email_str().
cms_encode_email_str() Encodes each character of the given string as either a decimal
or hexadecimal entity, in the hopes of foiling most email address
harvesting bots.
cms_editor() Renders an editor.
cms_optimized_image_upload() Returns an optimized image for use.
admin_dashboard_js() Loads javascript for backend dashboard.
cms_charset() CMS charset.
get_auth_screen_logo() Returns the auth screen logo.
get_user_avatar() Retrieve the avatar <img> tag for user.
get_user_avatar_url() Retrieves the avatar url.
cms_upload_image() Upload image button.
compare_releases() Compares release values.
get_http_response_code() Retrieves a response code from the header
of a given resource.
cms_dev_mode() Shows an error message when system is in DEV mode.
admin_head() Fires the admin_head action.
cms_head() Fires the frontend cms_head action.
admin_footer() Fires the admin_footer action via backend.
cms_footer() Fires the cms_footer action via the admin.
admin_enqueue_head()
admin_enqueue_footer()
add_admin_submenu() Add an admin submenu page link.
add_dashboard_submenu() Adds an admin dashboard submenu page link.
add_sites_submenu() Adds a sites submenu page link.
add_plugins_submenu() Adds a plugin submenu page link.
add_themes_submenu() Adds a theme submenu page link.
add_users_submenu() Adds a users submenu page link.
add_options_submenu() Adds an options submenu page link.
plugin_basename() Extracts the file name of a specific plugin.
register_activation_hook() When a plugin is activated, the action activate_name hook is called.
register_deactivation_hook() When a plugin is deactivated, the action deactivate_name hook is called.
plugin_dir_path() Get the filesystem directory path (with trailing slash) for the plugin FILE passed in.
active_plugins() Returns a list of all plugins that have been activated.
activate_plugin() Activates a specific plugin that is called by $_GET['id'] variable.
deactivate_plugin() Deactivates a plugin.
is_plugin_activated() Checks if a particular plugin has been activated.
load_active_plugins()
plugin_url() Retrieves a URL within the plugins or mu-plugins directory.
plugin_dir_url() Get the URL directory path (with trailing slash) for the plugin FILE passed in.
plugin_info() Retrieves meta data about a plugin.
get_products() Retrieve all the products regardless of status.
get_all_products_with_filters() Retrieve all products or a product based on filters.
get_product_by() Retrieve product by a given field from the product table.
get_product_by_id() Retrieve product by the product id.
get_product_datetime() A function which retrieves product datetime.
get_product_modified() A function which retrieves product modified datetime.
get_product_body() A function which retrieves a product body.
get_product_sku() A function which retrieves a product product_type name.
get_product_title() A function which retrieves a product title.
get_product_slug() A function which retrieves a product slug.
product_status_label() Adds label to product's status.
get_product_attribute() Retrieve product attribute for a product.
update_product_attribute() Update product attribute based on product ID.
add_product_attribute() Add attribute to a product.
delete_product_attribute() Remove attribute matching criteria from a product.
get_product_author_id() A function which retrieves a product author id.
get_product_author() A function which retrieves a product author.
get_product_status() A function which retrieves a product status.
get_product_date() A function which retrieves product date.
get_product_time() A function which retrieves product time.
get_product_created_date() Retrieves product created date.
the_product_created_date() Retrieves product created date.
get_product_created_time() A function which retrieves product created time.
the_product_created_time() Retrieves product created time.
get_product_published_date() A function which retrieves product published date.
the_product_published_date() Retrieves product published date.
get_product_published_time() A function which retrieves product published time.
the_product_published_time() Retrieves product published time.
get_product_modified_date() A function which retrieves product modified date.
the_product_modified_date() Retrieves product published date.
get_product_modified_time() A function which retrieves product modified time.
the_product_modified_time() Retrieves product modified time.
get_product_show_in_menu() A function which retrieves product show in menu.
get_product_show_in_search() A function which retrieves product show in search.
cms_unique_product_slug() Creates a unique product slug.
cms_insert_product() Insert or update a product.
cms_update_product() Update a product in the product document.
cms_delete_product() Deletes product from the product document.
get_product_class() Retrieves an array of CSS class names.
the_product_attribute() Retrieves and displays product attribute value.
currency_option() Currency dropdown options.
publish_scheduled_product()
get_all_sites() Retrieves all sites.
get_site_by() Retrieves site data given a site ID or site object.
if_site_domain_exists() Checks whether the given site domain exists.
if_site_exists() Checks whether the given site exists.
create_site_directories() Create the needed directories when a new site is created.
delete_site_tables() Deletes site tables when site is deleted.
delete_site_directories() Deletes the site directory when the site is deleted.
site_directory_key()
get_current_site_key() Retrieve the current site key.
get_current_site_id()
get_multisite_users() Retrieve a list of all users in the system.
site_user_lookup()
add_user_to_site() Add user to a site.
cms_insert_site() Insert a site into the database.
cms_update_site() Update a site in the database.
cms_delete_site() Deletes a site.
cms_delete_site_user() Deletes a user from the entire system.
remove_user_from_site()
new_site_schema() Creates new tables and user meta for site admin after new site
is created.
cms_site_status_label() Adds status label for site's table.
does_site_exist() Checks if site exists or is archived.
get_site_name() A function which retrieves cms site name.
get_site_domain() A function which retrieves cms site domain.
get_site_path() A function which retrieves cms site path.
get_site_owner() A function which retrieves cms site owner.
get_site_status() A function which retrieves cms site status.
cms_unique_site_slug() Creates a unique site slug.
get_siteinfo() Retrieves raw info about current site.
siteinfo() Retrieves filtered info about current site.
switch_to_site() Switches the current site.
restore_current_site() Restores the current site, after calling switch_to_site().
site_switching_in_effect() Determines if site switching is in effect.
is_main_site() Whether site is the main site.
get_theme() Retrieve name of the current theme.
theme_name() Retrieve active theme's name.
theme_url() Returns full base url of the themes' directory.
nav_links()
theme_directory_uri() Returns theme directory URI.
javascript_directory_uri() Returns javascript directory uri.
raw_theme_root() Returns raw theme root relative to the supplied path or filename.
theme_root() Get the filesystem directory path (with trailing slash) for the theme FILE passed in.
less_directory_uri() Retrieve less directory uri.
css_directory() Returns the base directory for theme stylesheet.
css_directory_uri() Return css directory uri.
image_directory_uri() Retrieve image directory uri.
fonts_directory_uri() Retrieve fonts directory uri.
theme_info() Retrieves metadata about a theme.
activate_theme() Activates a specific theme by namespace.
deactivate_theme() Deactivates an active theme.
is_theme_active() Checks if a theme is active.
load_active_theme() Executes the active theme.
has_content() Checks whether there is content.
the_content() Loops through all content.
content_id() The content's unique id.
content_title() The content's title.
content_slug() The content's slug.
content_body() The content's body.
content_author() The content's author.
content_featured_image() The content's featured image.
content_permalink() The content's permalink.
content_published_date() The content's published date.
content_published_time() The content's published time.
content_published_datetime() The content's published datetime.
has_products() Checks whether there are products.
the_product() Loops through all products.
product_id() The product's unique id.
product_title() The product's title.
product_slug() The product's slug.
product_body() The product's body.
product_author() The product's author.
product_sku() The product's sku.
product_price() The product's price.
product_currency() The product's currency.
product_purchase_url() The product's purchase url.
product_featured_image() The product's featured image.
product_permalink() The product's permalink.
product_published_date() The product's published date.
product_published_time() The product's published time.
product_published_datetime() The product's published datetime.
set_url_scheme() Sets the scheme for a URL.
add_query_arg() Retrieves a modified URL query string.
url() Returns the url based on route.
cms_site_url() Returns the url for a given site.
cms_admin_url() Returns the url to the admin area for a given site.
cms_home_url() Returns the url for a given site where the front end is accessible.
cms_login_url() Returns the login url for a given site.
cms_logout_url() Returns the login url for a given site.
site_url() Returns the url for a given site.
admin_url() Returns the url to the admin area for a given site.
home_url() Returns the url for a given site where the front end is accessible.
login_url() Returns the login url for a given site.
logout_url() Returns the login url for a given site.
admin_login_url() Returns the admin login url for a given site.
admin_logout_url() Returns the admin logout url for a given site.
get_all_users() Retrieves all users.
get_users_dropdown() Print a dropdown list of users.
user_lookup()
get_current_user_id() Get the current user's ID
cms_get_current_user() Returns object of data for current user.
get_user_by() Retrieve user info by a given field from the user's table.
get_userdata() Retrieve user info by user_id.
get_name() Returns the name of a particular user.
get_initials() Shows selected user's initials instead of
his/her full name.
get_user_value() Retrieve requested field from user meta table based on user's id.
username_exists() Checks whether the given username exists.
email_exists() Checks whether the given email exists.
get_system_roles() Retrieve a list of system defined user roles.
get_users_dropdown_list() Retrieve a list of all users as dropdown options.
get_user_attribute() Retrieve an attribute for specified user.
update_user_attribute()
delete_user_attribute() Remove attribute from user_attribute.
delete_site_user_record()
get_user_option() Retrieve user option that can be either per Site or global.
cms_insert_user() Insert a user into the database.
cms_update_user() Update a user in the database.
send_email_change_email() Email sent to user with changed/updated email.
blacklisted_usernames() An extensive list of blacklisted usernames.
reset_password() Resets a user's password.
get_users_reassign() Print a dropdown list of users.
get_users_by_site_key() Retrieves a list of users by site_key.
get_user_timezone() Returns the logged-in user's timezone.
get_user_date_format() Returns the logged-in user's date format.
get_user_time_format() Returns the logged-in user's time format.
get_user_datetime_format() Returns the logged in user's datetime format.
get_user_datetime() Returns datetime based on user's date format, time format, and timezone.

\App\Shared\Http

Classes

Class Description
StreamedResponse

\App\Shared\Pipes

Classes

\App\Shared\Services

Classes

\App\Shared\Services\Assets

Classes

Class Description
AppAssets
PluginAssets
ThemeAssets

\App\Shared\Services\Elfinder

Classes

Class Description
Connector
Elfinder

\App\Shared\Services\Shortcode

Classes

Class Description
BaseShortcode
ShortcodeRegistry

Interfaces

Interface Description
Shortcode

\App\Shared\Services\Trait

Traits

Trait Description
HydratorAware

\App\Shared\ValueObject

Classes