Skip to content

Latest commit

 

History

History
505 lines (253 loc) · 19 KB

a-constants-reference.md

File metadata and controls

505 lines (253 loc) · 19 KB

Appendix A - Constants Reference Edit in GitHub

PHP Constants used throughout WordPress Core.

  • ABSPATH

    Set in: wp-load.php 🔍, wp-config-sample.php 🔍

    Default value: dirname( __FILE__ )

    Description: Stores the absolute path to the WordPress root folder.

  • ADMIN_COOKIE_PATH

    Set in: default-constants.php 🔍

    Default Value: SITECOOKIEPATH . 'wp-admin'

    Description: Admin backend path to store the cookie under.

  • AUTH_COOKIE

    Set in: default-constants.php 🔍

    Default Value: 'wordpress_' . COOKIEHASH

    Description: Name of the cookie storing whether the user is authenticated over HTTP.

  • AUTH_KEY

    Set in: wp-config-sample.php 🔍

    Description: Authentication key used to generate an authentication cookie on HTTP connections.

  • AUTH_SALT

    Set in: wp-config-sample.php 🔍

    Description: Salt used on the authentication key for generating an authentication cookie on HTTP connections.

  • AUTOSAVE_INTERVAL

    Set in: default-constants.php 🔍

    Default Value: 60

    Description: Interval between automatic saves in seconds.

  • COOKIE_DOMAIN

    Set in: default-constants.php 🔍

    Default Value: false

    Description: Domain store the cookie under.

  • COOKIE_HASH

    Set in: default-constants.php 🔍

    Default Value: md5( $siteurl )

    Description: Used to guarantee unique cookie hashes.

  • COOKIEPATH

    Set in: default-constants.php 🔍

    Default Value: preg_replace('|https?://[^/]+|i', '', get_option('home') . '/' )

    Description: Home path to store the cookie under.

  • DB_CHARSET

    Set in: wp-config-sample.php 🔍

    Default value: 'utf8'

    Description: Database Charset to use in creating database tables.

  • DB_COLLATE

    Set in: wp-config-sample.php 🔍

    Default value: ''

    Description: The Database Collate type.

  • DB_HOST

    Set in: wp-config-sample.php 🔍

    Default value: 'localhost'

    Description: MySQL hostname.

  • DB_NAME

    Set in: wp-config-sample.php 🔍

    Description: The name of the database for WordPress.

  • DB_PASSWORD

    Set in: wp-config-sample.php 🔍

    Description: MySQL database password.

  • DB_USER

    Set in: wp-config-sample.php 🔍

    Description: MySQL database username.

  • DAY_IN_SECONDS

    Set in: default-constants.php 🔍

    Value: 24 * HOUR_IN_SECONDS

    Description: Constant for expressing human-readable intervals in their respective number of seconds.

  • EMPTY_TRASH_DAYS

    Set in: default-constants.php 🔍

    Default Value: 30

    Description: Interval between automatic removal of trashed elements in days.

  • FORCE_SSL_ADMIN

    Set in: default-constants.php 🔍

    Default Value: true|false based on get_option('siteurl') scheme

    Description: Whether to force the admin backend to always require a secure connection.

  • FORCE_SSL_LOGIN

    Description: Whether to force logged-in users to always require a secure connection.

  • GB_IN_BYTES

    Set in: default-constants.php 🔍

    Value: 1024 * MB_IN_BYTES

    Description: Constant for expressing human-readable data-sizes in their respective number of bytes.

  • HOUR_IN_SECONDS

    Set in: default-constants.php 🔍

    Value: 60 * MINUTE_IN_SECONDS

    Description: Constant for expressing human-readable intervals in their respective number of seconds.

  • KB_IN_BYTES

    Set in: default-constants.php 🔍

    Value: 1024

    Description: Constant for expressing human-readable data-sizes in their respective number of bytes.

  • LOGGED_IN_COOKIE

    Set in: default-constants.php 🔍

    Default Value: 'wordpress_logged_in_' . COOKIEHASH

    Description: Name of the cookie storing whether the user is logged in.

  • LOGGED_IN_KEY

    Set in: wp-config-sample.php 🔍

    Description: Key used to generate the logged-in cookie.

  • LOGGED_IN_SALT

    Set in: wp-config-sample.php 🔍

    Description: Salt used on the key for generating the logged-in cookie.

  • MB_IN_BYTES

    Set in: default-constants.php 🔍

    Value: 1024 * KB_IN_BYTES

    Description: Constant for expressing human-readable data-sizes in their respective number of bytes.

  • MEDIA_TRASH

    Set in: default-constants.php 🔍

    Default Value: false

    Description: Use trashcan when deleting media files.

  • MINUTE_IN_SECONDS

    Set in: default-constants.php 🔍

    Value: 60

    Description: Constant for expressing human-readable intervals in their respective number of seconds.

  • MONTH_IN_SECONDS

    Set in: default-constants.php 🔍

    Value: 30 * DAY_IN_SECONDS

    Description: Constant for expressing human-readable intervals in their respective number of seconds.

  • MUPLUGINDIR (deprecated)

    Set in: default-constants.php 🔍

    Default Value: wp-content/mu-plugins

    Description: Path to the mu-plugins folder.

  • NONCE_KEY

    Set in: wp-config-sample.php 🔍

    Description: Key used to generate a nonce.

  • NONCE_SALT

    Set in: wp-config-sample.php 🔍

    Description: Salt used on the key for generating a nonce.

  • PASS_COOKIE (deprecated)

    Set in: default-constants.php 🔍

    Default Value: 'wordpresspass_' . COOKIEHASH

    Description: Name of the cookie storing the user's double-hashed password.

  • PLUGINDIR (deprecated)

    Set in: default-constants.php 🔍

    Default Value: wp-content/plugins

    Description: Path to the plugins folder.

  • PLUGINS_COOKIE_PATH

    Set in: default-constants.php 🔍

    Default Value: preg_replace('|https?://[^/]+|i', '', WP_PLUGIN_URL )

    Description: Plugins folder path to store the cookie under.

  • SCRIPT_DEBUG

    Set in: default-constants.php 🔍

    Default Value: false

    Description: Load of non-minified, non-concatenated scripts and stylesheets.

  • SECURE_AUTH_COOKIE

    Set in: default-constants.php 🔍

    Default Value: 'wordpress_sec_' . COOKIEHASH

    Description: Name of the cookie storing whether the user is authenticated over HTTPS.

  • SECURE_AUTH_KEY

    Set in: wp-config-sample.php 🔍

    Description: Authentication key used to generate an authentication cookie on HTTPS connections.

  • SECURE_AUTH_SALT

    Set in: wp-config-sample.php 🔍

    Description: Salt used on the authentication key for generating an authentication cookie on HTTPS connections.

  • SHORTINIT

    Set in: default-constants.php 🔍

    Default Value: false

    Description: Short-circuit the WordPress loading process to run a minimal system.

  • SITECOOKIEPATH

    Set in: default-constants.php 🔍

    Default Value: preg_replace('|https?://[^/]+|i', '', get_option('siteurl') . '/' )

    Description: Site URL path to store the cookie under.

  • STYLESHEETPATH

    Set in: default-constants.php 🔍

    Default Value: get_stylesheet_directory()

    Description: Filesystem path to the current active template stylesheet directory.

  • TB_IN_BYTES

    Set in: default-constants.php 🔍

    Value: 1024 * GB_IN_BYTES

    Description: Constant for expressing human-readable data-sizes in their respective number of bytes.

  • TEMPLATEPATH

    Set in: default-constants.php 🔍

    Default Value: get_template_directory()

    Description: Filesystem path to the current active template directory.

  • TEST_COOKIE

    Set in: default-constants.php 🔍

    Default Value: 'wordpress_test_cookie_' . COOKIEHASH

    Description: Name of the cookie used to test whether the browser supports cookies.

  • USER_COOKIE (deprecated)

    Set in: default-constants.php 🔍

    Default Value: 'wordpressuser_' . COOKIEHASH

    Description: Name of the cookie storing the user name.

  • WEEK_IN_SECONDS

    Set in: default-constants.php 🔍

    Value: 7 * DAY_IN_SECONDS

    Description: Constant for expressing human-readable intervals in their respective number of seconds.

  • WP_CACHE

    Set in: default-constants.php 🔍

    Default Value: false

    Description: Cache generated WordPress output.

  • WP_CONTENT_DIR

    Set in: default-constants.php 🔍

    Default Value: ABSPATH . 'wp-content'

    Description: Path to the content folder.

  • WP_CONTENT_URL

    Set in: default-constants.php 🔍

    Default Value: get_option('siteurl') . '/wp-content'

    Description: URL location of the content folder.

  • WP_CRON_LOCK_TIMEOUT

    Set in: default-constants.php 🔍

    Default Value: 60

    Description: Timeout for the lock file for cron scripts in seconds.

  • WP_DEBUG

    Set in: wp-config-sample.php 🔍, default-constants.php 🔍

    Default value: false

    Description: WordPress debugging mode.

  • WP_DEBUG_DISPLAY

    Set in: default-constants.php 🔍

    Default value: true

    Description: Display PHP errors.

  • WP_DEBUG_LOG

    Set in: default-constants.php 🔍

    Default value: false

    Description: Log PHP errors to WP_CONTENT_DIR/debug.log.

  • WP_DEFAULT_THEME

    Set in: default-constants.php 🔍

    Default Value: 'twentyseventeen' (as of WordPress 4.8)

    Description: Default theme to pick if none was set.

  • WP_FEATURE_BETTER_PASSWORDS

    Set in: default-constants.php 🔍

    Default Value: true

    Description: Constant for "Better Passwords"-feature added to WordPress that should short-circuit its plugin implementation.

  • WP_MAX_MEMORY_LIMIT

    Set in: default-constants.php 🔍

    Default Value: 256M

    Description: PHP process maximum memory limit.

  • WP_MEMORY_LIMIT

    Set in: default-constants.php 🔍

    Default Value: 40M (64M on multisite)

    Description: PHP process default memory limit.

  • WP_PLUGIN_DIR

    Set in: default-constants.php 🔍

    Default Value: WP_CONTENT_DIR . '/plugins'

    Description: Path to the plugins folder.

  • WP_PLUGIN_URL

    Set in: default-constants.php 🔍

    Default Value: WP_CONTENT_URL . '/plugins'

    Description: URL location of the plugins folder.

  • WP_POST_REVISIONS

    Set in: default-constants.php 🔍

    Default Value: true

    Description: Whether to store multiple versioned revisions for edited posts.

  • WP_USE_THEMES

    Set in: index.php 🔍

    Default value: true

    Description: Tells WordPress to load the WordPress theme and output it.

  • WPINC

    Set in: wp-load.php 🔍

    Default value: 'wp-includes'

    Description: Directory name of the folder that contains the includes.

  • WPMU_PLUGIN_DIR

    Set in: default-constants.php 🔍

    Default Value: WP_CONTENT_DIR . '/mu-plugins'

    Description: Path to the mu-plugins folder.

  • WPMU_PLUGIN_URL

    Set in: default-constants.php 🔍

    Default Value: WP_CONTENT_URL . '/mu-plugins'

    Description: URL location of the mu-plugins folder.

  • YEAR_IN_SECONDS

    Set in: default-constants.php 🔍

    Value: 365 * DAY_IN_SECONDS

    Description: Constant for expressing human-readable intervals in their respective number of seconds.