User:Moraleida.me/Referencia de Funcoes

Languages: English • Français • Español • Italiano • 日本語 ქართული • Português do Brasil • Русский • Türkçe • 中文(简体) • 中文(繁體) • 한국어 • (Add your language)

1 Funções por categoria
2 Official and Unofficial References

Muitas funções úteis são definidas nos arquivos do WordPress. Algumas delas, conhecidas como Template Tags, foram criadas especificamente para uso nos Temas de sites WordPress. Além destas, existem também as funções relativas a ações e filtros (a API de Plugins) que são usadas primariamente para desenvolver Plugins. As demais funções são usadas para criar as funcionalidades presentes no núcleo mesmo do WordPress.

Várias dessas funções são úteis para desenvolvedores de Temas e Plugins, por isso este artigo lista a maioria das funções do núcleo - exceto as Template Tags. Ao final da página existe uma seção listando outros lugares onde você pode encontrar mais informações sobre as funções do WordPress. Além desses recursos, o site do phpdoc do WordPress detalha todas as funções por versão desde a 2.6.1.

Ajude a deixar esta página mais completa!

Here are some things you can do to help:

A maioria das funções listadas ainda não tem documentação em Português. Você pode traduzir as que usa mais e trocar o link para a versão traduzida.

Adicione documentação para funções ainda não documentadas, criando sub-páginas ou pelo menos inserindo comentários curtos na lista abaixo. Se criar uma página para uma função ainda não documentada, por favor, crie primeiro no artigo em inglês Function Reference, e só depois aqui.
Siga o modelo das páginas já criadas, incluíndo informações e exemplos de uso daquela função, se possível.
Liste mais funções aqui, respeitando a estrutura das categorias.
Corrija erros movendo funções para categorias mais apropriadas e, claro, corrigindo erros de digitação. Não tem problema se uma mesma função aparecer em mais de uma categoria.

E participe da comunidade para saber como contribuir mais e melhor!

Funções por categoria

Post, Custom Post Type, Page, Attachment and Bookmarks Functions

Posts

get_adjacent_post (en)
get_boundary_post (en)
get_children (en)
get_extended (en)
get_next_post (en)
get_next_posts_link (en)
get_permalink (en)
the_permalink (en)
get_the_excerpt (en)
the_excerpt (en)
get_the_post_thumbnail (en)
get_post (en)
get_post_ancestors (en)
get_post_mime_type (en)
get_post_status (en)
get_post_format (en)
set_post_format (en)
get_edit_post_link (en)
get_delete_post_link (en)
get_previous_post (en)
previous_posts_link (en)
get_posts (en)
is_post (en) (deprecated)
is_single (en)
is_sticky (en)
the_ID (en)
the_date (en)
wp_get_recent_posts (en)
wp_get_single_post (en) (deprecated)
has_post_thumbnail (en)
has_excerpt (en)
has_post_format (en)

Custom Post Type

Post insertion/removal

Pages

get_all_page_ids (en)
get_ancestors (en)
get_page (en)
get_page_link (en)
get_page_by_path (en)
get_page_by_title (en)
get_page_children (en)
get_page_hierarchy (en)
get_page_uri (en)
get_pages (en)
is_page (en)
page_uri_index (en) (method of class WP_Rewrite)
wp_link_pages (en)
wp_list_pages (en)
wp_page_menu (en)
wp_dropdown_pages (en)

Custom Fields (postmeta)

Attachments

get_attached_file (en)
image_resize (en) (deprecated)
image_edit_before_change (en) (ported to WP_Image_Editor object)
is_attachment (en)
is_local_attachment (en)
update_attached_file (en)
wp_attachment_is_image (en)
wp_create_thumbnail (en) (deprecated)
wp_insert_attachment (en)
wp_delete_attachment (en)
wp_get_attachment_image (en)
wp_get_attachment_link (en)
wp_get_attachment_image_src (en)
wp_get_attachment_metadata (en)
wp_get_attachment_thumb_file (en)
wp_get_attachment_thumb_url (en)
wp_get_attachment_url (en)
wp_check_for_changed_slugs (en)
wp_count_posts (en)
wp_get_mime_types (en)
wp_mime_type_icon (en)
wp_generate_attachment_metadata (en)
wp_prepare_attachment_for_js (en)
wp_update_attachment_metadata (en)

Bookmarks

Terms

Others

Category, Tag and Taxonomy Functions

Categories

Category Creation

Tags

get_tag (en)
get_tag_link (en)
get_tags (en)
get_the_tag_list (en)
get_the_tags (en)
is_tag (en)
the_tags (en)
tag_description (en)

Taxonomy

get_taxonomies (en)
get_term (en)
get_the_term_list (en)
get_term_by (en)
the_terms (en)
get_the_terms (en)
get_term_children (en)
get_term_link (en)
get_terms (en)
is_taxonomy (en) (deprecated)
is_taxonomy_hierarchical (en)
is_term (en) (deprecated)
taxonomy_exists (en)
term_exists (en)
register_taxonomy (en)
register_taxonomy_for_object_type (en)
wp_get_object_terms (en)
wp_set_object_terms (en)
wp_insert_term (en)
wp_update_term (en)
wp_delete_term (en)
wp_terms_checklist (en)

User and Author Functions

Admins, Roles and Capabilities

add_cap (en)
add_role (en)
author_can (en)
current_user_can (en)
current_user_can_for_blog (en)
get_role (en)
get_super_admins (en)
is_super_admin (en)
map_meta_cap (en)
remove_cap (en)
remove_role (en)
user_can (en)

Users and Authors

auth_redirect (en)
count_users (en)
count_user_posts (en)
count_many_users_posts (en)
email_exists (en)
get_currentuserinfo (en)
get_current_user_id (en)
get_profile (en) (deprecated)
get_user_by (en)
get_userdata (en)
get_usernumposts (en) (deprecated)
get_users (en)
set_current_user (en) (deprecated)
user_pass_ok (en) (deprecated)
username_exists (en)
validate_username (en)
wp_get_current_user (en)
wp_set_current_user (en)
get_author_posts_url (en)
get_the_modified_author (en)
is_multi_author (en)

User meta

User insertion/removal

Login / Logout

is_user_logged_in (en)
wp_login_form (en)
wp_signon (en)
wp_logout (en)

Feed Functions

bloginfo_rss (en)
comment_author_rss (en)
comment_link (en)
comment_text_rss (en)
do_feed (en)
do_feed_atom (en)
do_feed_rdf (en)
do_feed_rss (en)
do_feed_rss2 (en)
fetch_feed (en)
fetch_rss (en) (deprecated)
get_author_feed_link (en)
get_bloginfo_rss (en)
get_category_feed_link (en)
get_comment_link (en)
get_comment_author_rss (en)
get_post_comments_feed_link (en)
get_rss (en) (deprecated)
get_search_comments_feed_link (en)
get_search_feed_link (en)
get_the_category_rss (en)
get_the_title_rss (en)
permalink_single_rss (en) (deprecated)
post_comments_feed_link (en)
rss_enclosure (en)
the_title_rss (en)
the_category_rss (en)
the_content_rss (en)
the_excerpt_rss (en)
wp_rss (en) (deprecated)

HTTP API Functions
`wp_remote_get` (en) `wp_remote_retrieve_body` (en) `wp_get_http_headers` (en) `wp_remote_fopen` (en)

Comment, Ping, and Trackback Functions

Comments Loop

Comments Pagination

Action, Filter, and Plugin Functions

Filters (Reference)

Actions (Reference)

has_action (en)
add_action (en)
do_action (en)
do_action_ref_array (en)
did_action (en)
remove_action (en)
remove_all_actions (en)

Plugins (Reference)

Widgets (Reference)

Settings (Reference)

Shortcodes (Reference)

Theme-Related Functions

Include functions

comments_template (en)
get_footer (en)
get_header (en)
get_sidebar (en)
get_search_form (en)

Other functions

add_custom_background (en) (deprecated)
add_custom_image_header (en) (deprecated)
add_image_size (en)
add_theme_support (en)
body_class (en)
current_theme_supports (en)
dynamic_sidebar (en)
get_404_template (en)
get_archive_template (en)
get_attachment_template (en)
get_author_template (en)
get_body_class (en)
get_category_template (en)
get_comments_popup_template (en)
get_current_theme (en)
get_date_template (en)
get_header_image (en)
get_header_textcolor (en)
get_home_template (en)
get_locale_stylesheet_uri (en)
get_page_template (en)
get_paged_template (en)
get_post_class (en)
get_query_template (en)
get_search_template (en)
get_single_template (en)
get_stylesheet (en)
get_stylesheet_directory (en)
get_stylesheet_directory_uri (en)
get_stylesheet_uri (en)
get_tag_template (en)
get_taxonomy_template (en)
get_template (en)
get_template_directory (en)
get_template_directory_uri (en)
get_template_part
get_theme (en) (deprecated)
wp_get_themes (en)
get_theme_data (en) (deprecated)
get_theme_support (en)
get_theme_mod (en)
get_theme_mods (en)
get_theme_root (en)
get_theme_roots (en)
get_theme_root_uri (en)
get_themes (en) (deprecated)
header_image (en)
header_textcolor (en)
in_the_loop (en)
is_child_theme (en)
is_active_sidebar (en)
is_admin_bar_showing (en)
is_dynamic_sidebar (en)
language_attributes (en)
load_template (en)
locale_stylesheet (en)
locate_template (en)
post_class (en)
preview_theme (en)
preview_theme_ob_filter (en)
preview_theme_ob_filter_callback (en)
register_nav_menu (en)
register_nav_menus (en)
get_registered_nav_menus (en)
register_sidebar (en)
register_sidebars (en)
register_theme_directory (en)
remove_theme_mod (en)
remove_theme_mods (en)
remove_theme_support (en)
require_if_theme_supports (en)
search_theme_directories (en)
set_theme_mod (en)
switch_theme (en)
validate_current_theme (en)
unregister_nav_menu (en)
unregister_sidebar (en)
wp_clean_themes_cache (en)
wp_get_archives (en)
wp_get_nav_menu_items (en)
wp_get_theme (en)
wp_nav_menu (en)
wp_oembed_remove_provider (en)
wp_page_menu (en)
wp_title (en)

Formatting Functions

absint (en)
add_magic_quotes (en)
addslashes_gpc (en)
antispambot (en)
attribute_escape (en) (deprecated)
backslashit (en)
balanceTags (en)
clean_pre (en)
clean_url (en)
convert_chars (en)
convert_smilies (en)
ent2ncr (en)
esc_attr (en)
esc_html (en)
esc_js (en)
esc_textarea (en)
esc_sql (en)
esc_url (en)
esc_url_raw (en)
force_balance_tags (en)
format_to_edit (en)
format_to_post (en)
funky_javascript_fix (en) (depecrated)
htmlentities2 (en)
is_email (en)
js_escape (en) (deprecated)
make_clickable (en)
popuplinks (en)
remove_accents (en)
sanitize_email (en)
sanitize_file_name (en)
sanitize_html_class (en)
sanitize_key (en)
sanitize_mime_type (en)
sanitize_option (en)
sanitize_sql_orderby (en)
sanitize_text_field (en)
sanitize_title (en)
sanitize_title_for_query (en)
sanitize_title_with_dashes (en)
sanitize_user (en)
seems_utf8 (en)
stripslashes_deep (en)
trailingslashit (en)
untrailingslashit (en)
urlencode_deep (en)
url_shorten (en)
utf8_uri_encode (en)
wpautop (en)
wptexturize (en)
wp_filter_kses (en)
wp_filter_post_kses (en)
wp_filter_nohtml_kses (en)
wp_iso_descrambler (en)
wp_kses (en)
wp_kses_array_lc (en)
wp_kses_attr (en)
wp_kses_bad_protocol (en)
wp_kses_bad_protocol_once (en)
wp_kses_bad_protocol_once2 (en)
wp_kses_check_attr_val (en)
wp_kses_decode_entities (en)
wp_kses_hair (en)
wp_kses_hook (en)
wp_kses_html_error (en)
wp_kses_js_entities (en)
wp_kses_no_null (en)
wp_kses_normalize_entities (en)
wp_kses_normalize_entities2 (en)
wp_kses_split (en)
wp_kses_split2 (en)
wp_kses_stripslashes (en)
wp_kses_version (en)
wp_make_link_relative (en)
wp_rel_nofollow (en)
wp_richedit_pre (en)
wp_specialchars (en)
wp_trim_words (en)
zeroise (en)

Miscellaneous Functions

Time/Date Functions

Serialization

Options

add_option (en)
delete_option (en)
form_option (en)
get_alloptions (en) (deprecated)
get_site_option (en)
get_site_url (en)
get_user_option (en)
get_option (en)
update_option (en)
update_user_option (en)

Transients

Admin Menu Functions

Toolbar Functions

add_node (en)
remove_node (en)
add_group (en)
get_node (en)
get_nodes (en)

Form Helpers

checked (en)
disabled (en)
selected (en)
submit_button (en)
get_submit_button (en)

Nonces and Referers (Security)

XMLRPC

Localization

__ (en)
_x (en)
_n (en)
_nx (en)
_e (en)
_ex (en)
_ngettext (deprecated) (en)
esc_attr__ (en)
esc_attr_e (en)
get_locale (en)
load_default_textdomain (en)
load_plugin_textdomain (en)
load_textdomain (en)
load_theme_textdomain (en)
is_rtl (en)

Cron (Scheduling)

Conditional Tags Index

comments_open (en)
has_nav_menu (en)
has_tag (en)
in_category (en)
is_404 (en)
is_admin (en)
is_archive (en)
is_attachment (en)
is_author (en)
is_category (en)
is_comments_popup (en)
is_date (en)
is_day (en)
is_feed (en)
is_front_page (en)
is_home (en)
is_month (en)
is_page (en)
is_page_template (en)
is_paged (en)
is_preview (en)
is_search (en)
is_single (en)
is_singular (en)
is_sticky (en)
is_tag (en)
is_tax (en)
is_time (en)
is_trackback (en)
is_year (en)
pings_open (en)

Script and Style Registration

sql

Miscellaneous

add_editor_style (en)
add_query_arg (en)
add_rewrite_rule (en)
admin_url (en)
bool_from_yn (en)
cache_javascript_headers (en)
capital_P_dangit (en)
clean_blog_cache (en)
content_url (en)
do_robots (en)
flush_rewrite_rules (en)
get_bloginfo (en)
get_num_queries (en)
get_post_stati (en)
get_post_statuses (en)
get_query_var (en)
home_url (en)
includes_url (en)
is_blog_installed (en)
is_main_site (en)
is_main_query (en)
is_multisite (en)
is_ssl (en)
is_wp_error (en)
log_app (en)
make_url_footnote (en) (deprecated)
network_admin_url (en)
network_home_url (en)
network_site_url (en)
nocache_headers (en)
plugin_dir_url (en)
query_posts (en)
remove_query_arg (en)
rewind_posts (en)
setup_postdata (en)
site_url (en)
status_header (en)
wp (en)
wp_cache_set (en)
wp_cache_get (en)
wp_cache_reset (en) (deprecated)
wp_check_filetype (en)
wp_clearcookie (en) (deprecated)
wp_die (en)
wp_editor (en)
wp_footer (en)
wp_get_cookie_login (en) (deprecated)
wp_get_image_editor (en)
wp_hash (en)
wp_handle_sideload (en)
wp_head (en)
wp_install_defaults (en)
wp_is_mobile (en)
wp_mail (en)
wp_mkdir_p (en)
wp_new_user_notification (en)
wp_password_change_notification (en)
wp_notify_moderator (en)
wp_notify_postauthor (en)
wp_parse_args (en)
wp_redirect (en)
wp_reset_postdata (en)
wp_reset_query (en)
wp_salt (en)
wp_set_auth_cookie (en)
wp_safe_redirect (en)
wp_upload_bits (en)
wp_upload_dir (en)
wp_list_pluck (en)
wp_text_diff (en)
post_submit_meta_box (en)

Multisite functions

As of v3.0, WordPress includes WPMU functionality. Old WPMU functions reference can be found at http://codex.wordpress.org/WPMU_Functions (deprecated page).

Multisite administration Functions

These functions are found in file wp-admin/includes/ms.php (since 3.0.0).

admin_notice_feed (en) (deprecated)
avoid_blog_page_permalink_collision (en)
check_import_new_users (en)
check_upload_size (en)
choose_primary_blog (en)
display_space_usage (en)
fix_import_form_size (en)
format_code_lang (en)
get_site_allowed_themes (en) (deprecated)
grant_super_admin (en)
ms_deprecated_blogs_file (en) (deprecated)
mu_dropdown_languages (en)
new_user_email_admin_notice (en)
redirect_user_to_blog (en) (deprecated)
refresh_user_details (en)
revoke_super_admin (en)
secret_salt_warning (en)
send_confirmation_on_profile_email (en)
show_post_thumbnail_warning (en) (deprecated)
site_admin_notice (en)
sync_category_tag_slugs (en)
update_option_new_admin_email (en)
update_user_status (en)
upload_is_user_over_quote (en)
upload_space_setting (en)
wpmu_delete_blog (en)
wpmu_delete_user (en)
wpmu_get_blog_allowedthemes (en) (deprecated)
_admin_notice_multisite_activate_plugins_page (en) (deprecated)

Multisite Functions

Site/blog functions that work with the blogs table and related data, found in file wp-includes/ms-blogs.php (since 3.0.0).

Defines constants and global variables that can be overridden, generally in wp-config.php, found in file wp-includes/ms-default-constants.php (since 3.0.0).

Multisite WordPress API, found in file wp-includes/ms-functions.php (since 3.0.0).

add_existing_user_to_blog (en)
add_new_user_to_blog (en)
add_user_to_blog (en)
check_upload_mimes (en)
create_empty_blog (en)
domain_exists (en)
filter_SSL (en)
fix_phpmailer_messageid (en)
force_ssl_content (en)
get_active_blog_for_user (en)
get_admin_users_for_domain (en)
get_blogs_of_user (en)
get_blog_count (en)
get_blog_id_from_url (en)
get_blog_permalink (en)
get_blog_post (en)
get_current_site (en)
get_dashboard_blog (en)
get_dirsize (en)
get_most_recent_post_of_user (en)
get_sitestats (en)
get_space_allowed (en)
get_space_used (en)
get_upload_space_available (en)
get_user_count (en)
get_user_id_from_string (en)
global_terms (en)
insert_blog (en)
install_blog (en)
install_blog_defaults (en)
is_blog_user (en)
is_email_address_unsafe (en)
is_upload_space_available (en)
is_user_option_local (en)
is_user_spammy (en)
maybe_add_existing_user_to_blog (en)
maybe_redirect_404 (en)
newblog_notify_siteadmin (en)
newuser_notify_siteadmin (en)
recurse_dirsize (en)
redirect_mu_dashboard (en) (not a function??)
redirect_this_site (en)
remove_user_from_blog (en)
signup_nonce_check (en)
signup_nonce_fields (en)
update_blog_public (en)
update_posts_count (en)
upload_is_file_too_big (en)
upload_is_user_over_quota (en)
upload_size_limit_filter (en)
users_can_register_signup_filter (en)
welcome_user_msg_filter (en)
wordpressmu_wp_mail_from (en) (not a function??)
wpmu_activate_signup (en)
wpmu_admin_redirect_add_updated_param (en) (deprecated)
wpmu_create_blog (en)
wpmu_create_user (en)
wpmu_log_new_registrations (en)
wpmu_signup_blog (en)
wpmu_signup_blog_notification (en)
wpmu_signup_user (en)
wpmu_signup_user_notification (en)
wpmu_validate_blog_signup (en)
wpmu_validate_user_signup (en)
wpmu_welcome_notification (en)
wpmu_welcome_user_notification (en)

These functions are needed to load Multisite, found in file wp-includes/ms-load.php (since 3.0.0).

Official and Unofficial References

WordPress.org PHPDoc - Nearly all the functions in WordPress have "PHPDoc" headers. This site shows all the PHPDoc.
Trac Browser - WordPress source code. Choose 'Tags' to find a specific version source code, or 'Trunk' to see the latest version source code.
PHPXref for WordPress - Cross reference of WordPress files, functions, and variables, which seems to point to the latest released version. This redalt.com PHPXref site has the bleeding-edge Trunk version, as well as 1.5 and 2.0, but the Trunk version may not be updating any more. So, there is now a new Trunk Xref site on ftwr.co.uk available.
WordPress Function History Table - List each WordPress function with including the version it was introduced in or dropped in. PlanetOzh recommends: "see related WordPress Functions Implementation History Tool for more information (and for a more usable tool)"
WordPress Variable Report - A list of WordPress functions, listing what version of PHP every function requires (and if there's a compatible function available), what varables/arguments in functions are unused, and what functions/variables each class contains (and their default values).
WordPress Hooks Table - A list of WordPress actions and filters, cross-referenced to the files they are in

Codex