Collaboration diagram for API:
Files | |
| file | api.php |
| The web entry point for all Action API queries, handled by ApiMain and ApiBase subclasses. | |
| file | ApiEntryPoint.php |
| Entry point implementation for all Action API queries, handled by ApiMain and ApiBase subclasses. | |
Classes | |
| class | MediaWiki\Api\ApiAcquireTempUserName |
| Acquire a temporary user username and stash it in the current session, if temp account creation is enabled and the current user is logged out. More... | |
| class | MediaWiki\Api\ApiAMCreateAccount |
| Create an account with AuthManager. More... | |
| class | MediaWiki\Api\ApiAuthManagerHelper |
| Helper class for AuthManager-using API modules. More... | |
| class | MediaWiki\Api\ApiBase |
| This abstract class implements many basic API functions, and is the base of all API classes. More... | |
| class | MediaWiki\Api\ApiBlock |
| API module that facilitates the blocking of users. More... | |
| class | MediaWiki\Api\ApiChangeAuthenticationData |
| Change authentication data with AuthManager. More... | |
| class | MediaWiki\Api\ApiChangeContentModel |
| Api module to change the content model of existing pages. More... | |
| class | MediaWiki\Api\ApiCheckToken |
| class | MediaWiki\Api\ApiClearHasMsg |
| API module that clears the hasmsg flag for current user. More... | |
| class | MediaWiki\Api\ApiClientLogin |
| Log in to the wiki with AuthManager. More... | |
| class | MediaWiki\Api\ApiComparePages |
| class | MediaWiki\Api\ApiContinuationManager |
| This manages continuation state. More... | |
| class | MediaWiki\Api\ApiCSPReport |
| Api module to receive and log CSP violation reports. More... | |
| class | MediaWiki\Api\ApiDelete |
| API module that facilitates deleting pages. More... | |
| class | MediaWiki\Api\ApiDisabled |
| API module that dies with an error immediately. More... | |
| class | MediaWiki\Api\ApiEditPage |
| A module that allows for editing and creating pages. More... | |
| class | MediaWiki\Api\ApiEmailUser |
| API Module to facilitate sending of emails to users. More... | |
| class | MediaWiki\Api\ApiErrorFormatter |
| Formats errors and warnings for the API, and add them to the associated ApiResult. More... | |
| class | MediaWiki\Api\ApiErrorFormatter_BackCompat |
| Format errors and warnings in the old style, for backwards compatibility. More... | |
| class | MediaWiki\Api\ApiExpandTemplates |
| API module that functions as a shortcut to the wikitext preprocessor. More... | |
| class | MediaWiki\Api\ApiFeedContributions |
| class | MediaWiki\Api\ApiFeedRecentChanges |
| Recent changes feed. More... | |
| class | MediaWiki\Api\ApiFeedWatchlist |
| This action allows users to get their watchlist items in RSS/Atom formats. More... | |
| class | MediaWiki\Api\ApiFileRevert |
| class | MediaWiki\Api\ApiFormatBase |
| This is the abstract base class for API formatters. More... | |
| class | MediaWiki\Api\ApiFormatFeedWrapper |
| This printer is used to wrap an instance of the Feed class. More... | |
| class | MediaWiki\Api\ApiFormatJson |
| API JSON output formatter. More... | |
| class | MediaWiki\Api\ApiFormatNone |
| Formatter that outputs nothing, for when you don't care about the response at all. More... | |
| class | MediaWiki\Api\ApiFormatPhp |
| API Serialized PHP output formatter. More... | |
| class | MediaWiki\Api\ApiFormatRaw |
| Formatter that spits out anything you like with any desired MIME type. More... | |
| class | MediaWiki\Api\ApiFormatXml |
| API XML output formatter. More... | |
| class | MediaWiki\Api\ApiFormatXmlRsd |
| class | MediaWiki\Api\ApiHelp |
| Class to output help for an API module. More... | |
| class | MediaWiki\Api\ApiHelpParamValueMessage |
| Message subclass that prepends wikitext for API help. More... | |
| class | MediaWiki\Api\ApiImageRotate |
| class | MediaWiki\Api\ApiImport |
| API module that imports an XML file like Special:Import does. More... | |
| class | MediaWiki\Api\ApiImportReporter |
| Import reporter for the API. More... | |
| class | MediaWiki\Api\ApiLinkAccount |
| Link an account with AuthManager. More... | |
| class | MediaWiki\Api\ApiLogin |
| Unit to authenticate log-in attempts to the current wiki. More... | |
| class | MediaWiki\Api\ApiLogout |
| API module to allow users to log out of the wiki. More... | |
| class | MediaWiki\Api\ApiMain |
| This is the main API class, used for both external and internal processing. More... | |
| class | MediaWiki\Api\ApiManageTags |
| class | MediaWiki\Api\ApiMergeHistory |
| API Module to merge page histories. More... | |
| class | MediaWiki\Api\ApiMessage |
| Extension of Message implementing IApiMessage. More... | |
| class | MediaWiki\Api\ApiModuleManager |
| This class holds a list of modules and handles instantiation. More... | |
| class | MediaWiki\Api\ApiMove |
| API Module to move pages. More... | |
| class | MediaWiki\Api\ApiOpenSearch |
| class | MediaWiki\Api\ApiOpenSearchFormatJson |
| class | MediaWiki\Api\ApiOptions |
| API module that facilitates the changing of user's preferences. More... | |
| class | MediaWiki\Api\ApiOptionsBase |
| The base class for core's ApiOptions and two modules in the GlobalPreferences extension. More... | |
| class | MediaWiki\Api\ApiPageSet |
| This class contains a list of pages that the client has requested. More... | |
| class | MediaWiki\Api\ApiParamInfo |
| class | MediaWiki\Api\Validator\ApiParamValidator |
| This wraps a bunch of the API-specific parameter validation logic. More... | |
| class | MediaWiki\Api\Validator\ApiParamValidatorCallbacks |
| ParamValidator callbacks for the Action API. More... | |
| class | MediaWiki\Api\ApiParse |
| class | MediaWiki\Api\ApiPatrol |
| Allows user to patrol pages. More... | |
| class | MediaWiki\Api\ApiProtect |
| class | MediaWiki\Api\ApiPurge |
| API interface for page purging. More... | |
| class | MediaWiki\Api\ApiQuery |
| This is the main query class. More... | |
| class | MediaWiki\Api\ApiQueryAllCategories |
| Query module to enumerate all categories, even the ones that don't have category pages. More... | |
| class | MediaWiki\Api\ApiQueryAllDeletedRevisions |
| Query module to enumerate all deleted revisions. More... | |
| class | MediaWiki\Api\ApiQueryAllImages |
| Query module to enumerate all images. More... | |
| class | MediaWiki\Api\ApiQueryAllLinks |
| Query module to enumerate links from all pages together. More... | |
| class | MediaWiki\Api\ApiQueryAllMessages |
| A query action to return messages from site message cache. More... | |
| class | MediaWiki\Api\ApiQueryAllPages |
| Query module to enumerate all available pages. More... | |
| class | MediaWiki\Api\ApiQueryAllRevisions |
| Query module to enumerate all revisions. More... | |
| class | MediaWiki\Api\ApiQueryAllUsers |
| Query module to enumerate all registered users. More... | |
| class | MediaWiki\Api\ApiQueryAuthManagerInfo |
| A query action to return meta information about AuthManager state. More... | |
| class | MediaWiki\Api\ApiQueryBacklinks |
| This is a three-in-one module to query: More... | |
| class | MediaWiki\Api\ApiQueryBacklinksprop |
| This implements prop=redirects, prop=linkshere, prop=catmembers, prop=transcludedin, and prop=fileusage. More... | |
| class | MediaWiki\Api\ApiQueryBase |
| This is a base class for all Query modules. More... | |
| class | MediaWiki\Api\ApiQueryBlocks |
| Query module to enumerate all user blocks. More... | |
| class | MediaWiki\Api\ApiQueryCategories |
| A query module to enumerate categories the set of pages belong to. More... | |
| class | MediaWiki\Api\ApiQueryCategoryInfo |
| This query adds the "<categories>" subelement to all pages with the list of categories the page is in. More... | |
| class | MediaWiki\Api\ApiQueryCategoryMembers |
| A query module to enumerate pages that belong to a category. More... | |
| class | MediaWiki\Api\ApiQueryContributors |
| A query module to show contributors to a page. More... | |
| class | MediaWiki\Api\ApiQueryDeletedRevisions |
| Query module to enumerate deleted revisions for pages. More... | |
| class | MediaWiki\Api\ApiQueryDeletedrevs |
| Query module to enumerate all deleted revisions. More... | |
| class | MediaWiki\Api\ApiQueryDisabled |
| API module that does nothing. More... | |
| class | MediaWiki\Api\ApiQueryDuplicateFiles |
| A query module to list duplicates of the given file(s) More... | |
| class | MediaWiki\Api\ApiQueryExternalLinks |
| A query module to list all external URLs found on a given set of pages. More... | |
| class | MediaWiki\Api\ApiQueryExtLinksUsage |
| class | MediaWiki\Api\ApiQueryFilearchive |
| Query module to enumerate all deleted files. More... | |
| class | MediaWiki\Api\ApiQueryFileRepoInfo |
| A query action to return meta information about the foreign file repos configured on the wiki. More... | |
| class | MediaWiki\Api\ApiQueryGeneratorBase |
| class | MediaWiki\Api\ApiQueryImageInfo |
| A query action to get image information and upload history. More... | |
| class | MediaWiki\Api\ApiQueryImages |
| This query adds an "<images>" subelement to all pages with the list of images embedded into those pages. More... | |
| class | MediaWiki\Api\ApiQueryInfo |
| A query module to show basic page information. More... | |
| class | MediaWiki\Api\ApiQueryIWBacklinks |
| This gives links pointing to the given interwiki. More... | |
| class | MediaWiki\Api\ApiQueryIWLinks |
| A query module to list all interwiki links on a page. More... | |
| class | MediaWiki\Api\ApiQueryLangBacklinks |
| This gives links pointing to the given interwiki. More... | |
| class | MediaWiki\Api\ApiQueryLangLinks |
| A query module to list all langlinks (links to corresponding foreign language pages). More... | |
| class | MediaWiki\Api\ApiQueryLanguageinfo |
| API module to enumerate language information. More... | |
| class | MediaWiki\Api\ApiQueryLinks |
| A query module to list all wiki links on a given set of pages. More... | |
| class | MediaWiki\Api\ApiQueryLogEvents |
| Query action to List the log events, with optional filtering by various parameters. More... | |
| class | MediaWiki\Api\ApiQueryMyStashedFiles |
| action=query&list=mystashedfiles module, gets all stashed files for the current user. More... | |
| class | MediaWiki\Api\ApiQueryPagePropNames |
| A query module to list used page props. More... | |
| class | MediaWiki\Api\ApiQueryPageProps |
| A query module to show basic page information. More... | |
| class | MediaWiki\Api\ApiQueryPagesWithProp |
| A query module to enumerate pages that use a particular prop. More... | |
| class | MediaWiki\Api\ApiQueryPrefixSearch |
| class | MediaWiki\Api\ApiQueryProtectedTitles |
| Query module to enumerate all create-protected pages. More... | |
| class | MediaWiki\Api\ApiQueryQueryPage |
| Query module to get the results of a QueryPage-based special page. More... | |
| class | MediaWiki\Api\ApiQueryRandom |
| Query module to get list of random pages. More... | |
| class | MediaWiki\Api\ApiQueryRecentChanges |
| A query action to enumerate the recent changes that were done to the wiki. More... | |
| class | MediaWiki\Api\ApiQueryRevisions |
| A query action to enumerate revisions of a given page, or show top revisions of multiple pages. More... | |
| class | MediaWiki\Api\ApiQueryRevisionsBase |
| A base class for functions common to producing a list of revisions. More... | |
| class | MediaWiki\Api\ApiQuerySearch |
| Query module to perform full text search within wiki titles and content. More... | |
| class | MediaWiki\Api\ApiQuerySiteinfo |
| A query action to return meta information about the wiki site. More... | |
| class | MediaWiki\Api\ApiQueryStashImageInfo |
| A query action to get image information from temporarily stashed files. More... | |
| class | MediaWiki\Api\ApiQueryTags |
| Query module to enumerate change tags. More... | |
| class | MediaWiki\Api\ApiQueryTokens |
| Module to fetch tokens via action=query&meta=tokens. More... | |
| class | MediaWiki\Api\ApiQueryUserContribs |
| This query action adds a list of a specified user's contributions to the output. More... | |
| class | MediaWiki\Api\ApiQueryUserInfo |
| Query module to get information about the currently logged-in user. More... | |
| class | MediaWiki\Api\ApiQueryUsers |
| Query module to get information about a list of users. More... | |
| class | MediaWiki\Api\ApiQueryWatchlist |
| This query action allows clients to retrieve a list of recently modified pages that are part of the logged-in user's watchlist. More... | |
| class | MediaWiki\Api\ApiQueryWatchlistRaw |
| This query action allows clients to retrieve a list of pages on the logged-in user's watchlist. More... | |
| class | MediaWiki\Api\ApiRawMessage |
| Extension of RawMessage implementing IApiMessage. More... | |
| class | MediaWiki\Api\ApiRemoveAuthenticationData |
| Remove authentication data from AuthManager. More... | |
| class | MediaWiki\Api\ApiResetPassword |
| Reset password, with AuthManager. More... | |
| class | MediaWiki\Api\ApiResult |
| This class represents the result of the API operations. More... | |
| class | MediaWiki\Api\ApiRevisionDelete |
| API interface to RevDel. More... | |
| class | MediaWiki\Api\ApiRollback |
| class | MediaWiki\Api\ApiRsd |
| API module for sending out RSD information. More... | |
| interface | MediaWiki\Api\ApiSerializable |
| This interface allows for overriding the default conversion applied by ApiResult::validateValue(). More... | |
| class | MediaWiki\Api\ApiSetNotificationTimestamp |
| API interface for setting the wl_notificationtimestamp field. More... | |
| class | MediaWiki\Api\ApiSetPageLanguage |
| API module that facilitates changing the language of a page. More... | |
| class | MediaWiki\Api\ApiStashEdit |
| Prepare an edit in shared cache so that it can be reused on edit. More... | |
| class | MediaWiki\Api\ApiTag |
| class | MediaWiki\Api\ApiUnblock |
| API module that facilitates the unblocking of users. More... | |
| class | MediaWiki\Api\ApiUndelete |
| class | MediaWiki\Api\ApiUpload |
| class | MediaWiki\Api\ApiUsageException |
| Exception used to abort API execution with an error. More... | |
| class | MediaWiki\Api\ApiUserrights |
| class | MediaWiki\Api\ApiValidatePassword |
| class | MediaWiki\Api\ApiWatch |
| API module to allow users to watch a page. More... | |
| interface | MediaWiki\Api\IApiMessage |
| Interface for messages with machine-readable data for use by the API. More... | |
Variables | |
| trait | MediaWiki\Api::ApiBlockInfoTrait |
| trait | MediaWiki\Api::ApiCreateTempUserTrait |
| Methods needed by APIs that create a temporary user. | |
| trait | MediaWiki\Api::ApiMessageTrait |
| Trait to implement the IApiMessage interface for Message subclasses. | |
| trait | MediaWiki\Api::ApiQueryBlockInfoTrait |
| trait | MediaWiki\Api::ApiWatchlistTrait |
| An ApiWatchlistTrait adds class properties and convenience methods for APIs that allow you to watch a page. | |
| trait | MediaWiki\Api::SearchApi |
| Traits for API components that use a SearchEngine. | |
Detailed Description
Variable Documentation
◆ ApiBlockInfoTrait
| trait MediaWiki::Api\ApiBlockInfoTrait |
Definition at line 35 of file ApiBlockInfoTrait.php.
◆ ApiCreateTempUserTrait
| trait MediaWiki::Api\ApiCreateTempUserTrait |
Methods needed by APIs that create a temporary user.
This should only be added to classes that extend ApiBase.
- Since
- 1.42
Definition at line 17 of file ApiCreateTempUserTrait.php.
◆ ApiMessageTrait
| trait MediaWiki::Api\ApiMessageTrait |
Trait to implement the IApiMessage interface for Message subclasses.
- Since
- 1.27
Definition at line 32 of file ApiMessageTrait.php.
◆ ApiQueryBlockInfoTrait
| trait MediaWiki::Api\ApiQueryBlockInfoTrait |
Initial value:
{
Definition at line 36 of file ApiQueryBlockInfoTrait.php.
◆ ApiWatchlistTrait
| trait MediaWiki::Api\ApiWatchlistTrait |
Initial value:
{
private bool $watchlistExpiryEnabled
An ApiWatchlistTrait adds class properties and convenience methods for APIs that allow you to watch a page.
This should ONLY be used in API modules that extend ApiBase. Also, it should not be used in ApiWatch, which has its own special handling.
Note the class-level properties watchlistExpiryEnabled and watchlistMaxDuration must still be set in the API module's constructor.
- Since
- 1.35
Definition at line 26 of file ApiWatchlistTrait.php.
◆ SearchApi
| trait MediaWiki::Api\SearchApi |
Initial value:
{
private SearchEngineConfig $searchEngineConfig
Configuration handling class for SearchEngine.
Definition SearchEngineConfig.php:18
Traits for API components that use a SearchEngine.
Definition at line 37 of file SearchApi.php.
