Skip to content

Latest commit

 

History

History
59 lines (53 loc) · 8.77 KB

c-pluggable-functionality-reference.md

File metadata and controls

59 lines (53 loc) · 8.77 KB

Appendix C - Pluggable Functionality Reference Edit in GitHub

Drop-ins (pluggable files)

These files can be dropped into WP_CONTENT_DIR to replace the provided default implementation.

  • advanced-cache.php - Advanced caching plugin (only when WP_CACHE=true)
  • blog-deleted.php - Custom site deleted message
  • blog-inactive.php - Custom site inactive message
  • blog-suspended.php - Custom site suspended message
  • db.php - Custom database class
  • db-error.php - Custom database error message
  • install.php - Custom install script
  • maintenance.php - Custom maintenance message
  • object-cache.php - External object cache
  • sunrise.php - Executed before Multisite is loaded (only when SUNRISE=true)

Pluggable functions

These are located in WPINC\pluggable.php. If one of these is already declared, the default declaration is skipped.

  • _wp_sanitize_utf8_in_redirect - Performs a safe (local) redirect, using wp_redirect() 🔍
  • auth_redirect - Checks if a user is logged in, if not it redirects them to the login page 🔍
  • cache_users - Retrieve info for user lists to prevent multiple queries by get_userdata() 🔍
  • check_admin_referer - Makes sure that a user was referred from another admin page 🔍
  • check_ajax_referer - Verifies the Ajax request to prevent processing requests external of the blog 🔍
  • get_avatar - Retrieve the avatar <img> tag for a user 🔍
  • get_user_by - Retrieve user info by a given field 🔍
  • get_userdata - Retrieve user info by user ID 🔍
  • is_user_logged_in - Checks if the current visitor is a logged in user 🔍
  • wp_authenticate - Authenticate a user, confirming the login credentials are valid 🔍
  • wp_check_password - Checks the plaintext password against the encrypted password 🔍
  • wp_clear_auth_cookie - Removes all of the cookies associated with authentication 🔍
  • wp_create_nonce - Creates a cryptographic token tied to a specific action, user, user session and window of time 🔍
  • wp_generate_auth_cookie - Generate authentication cookie contents 🔍
  • wp_generate_password - Generates a random password drawn from the defined set of characters 🔍
  • wp_get_current_user - Retrieve the current user object 🔍
  • wp_hash_password - Create a hash (encrypt) of a plain text password 🔍
  • wp_hash - Get hash of given string 🔍
  • wp_logout - Log the current user out 🔍
  • wp_mail - Send mail, similar to PHP's mail 🔍
  • wp_new_user_notification - Email login credentials to a newly-registered user 🔍
  • wp_nonce_tick - Get the time-dependent variable for nonce creation 🔍
  • wp_notify_moderator - Notifies the moderatorabout a new comment that is awaiting approval 🔍
  • wp_notify_postauthor - Notify an author (and/or others) of a comment/trackback/pingback on a post 🔍
  • wp_parse_auth_cookie - Parse a cookie into its components 🔍
  • wp_password_change_notification - Notify the blog admin of a user changing password, normally via email 🔍
  • wp_rand - Generates a random number 🔍
  • wp_redirect - Redirects to another page 🔍
  • wp_safe_redirect - Performs a safe (local) redirect, using wp_redirect() 🔍
  • wp_salt - Get salt to add to hashes 🔍
  • wp_sanitize_redirect - Sanitizes a URL for use in a redirect 🔍
  • wp_set_auth_cookie - Log in a user by setting authentication cookies 🔍
  • wp_set_current_user - Change the current user by ID or name 🔍
  • wp_set_password - Updates the user's password with a new encrypted one 🔍
  • wp_text_diff - Display a human readable difference between two strings 🔍
  • wp_validate_auth_cookie - Validates authentication cookie 🔍
  • wp_validate_redirect - Validates a URL for use in a redirect 🔍
  • wp_verify_nonce - Verify that correct nonce was used with time limit 🔍