Umherirrender has uploaded a new change for review.
https://gerrit.wikimedia.org/r/196602
Change subject: Update code examples in docs/hooks.txt
......................................................................
Update code examples in docs/hooks.txt
Adjust for code convention and wfRunHooks -> Hooks::run
Bug: T85588
Change-Id: I0297e389eb761822b0b5b9ea7a0a0a7990790677
---
M docs/hooks.txt
1 file changed, 36 insertions(+), 36 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/02/196602/1
diff --git a/docs/hooks.txt b/docs/hooks.txt
index 62285df..f761419 100644
--- a/docs/hooks.txt
+++ b/docs/hooks.txt
@@ -34,15 +34,15 @@
uppercase letters. Currently, in MediaWiki code, we would handle this as
follows
(note: not real code, here):
- function showAnArticle($article) {
+ function showAnArticle( $article ) {
global $wgReverseTitle, $wgCapitalizeTitle;
- if ($wgReverseTitle) {
- wfReverseTitle($article);
+ if ( $wgReverseTitle ) {
+ wfReverseTitle( $article );
}
- if ($wgCapitalizeTitle) {
- wfCapitalizeTitle($article);
+ if ( $wgCapitalizeTitle ) {
+ wfCapitalizeTitle( $article );
}
# code to actually show the article goes here
@@ -52,34 +52,34 @@
function -- with or without a global variable. For example, someone wanting
email notification when an article is shown may add:
- function showAnArticle($article) {
+ function showAnArticle( $article ) {
global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
- if ($wgReverseTitle) {
- wfReverseTitle($article);
+ if ( $wgReverseTitle ) {
+ wfReverseTitle( $article );
}
- if ($wgCapitalizeTitle) {
- wfCapitalizeTitle($article);
+ if ( $wgCapitalizeTitle ) {
+ wfCapitalizeTitle( $article );
}
# code to actually show the article goes here
- if ($wgNotifyArticle) {
- wfNotifyArticleShow($article);
+ if ( $wgNotifyArticle ) {
+ wfNotifyArticleShow( $article );
}
}
Using a hook-running strategy, we can avoid having all this option-specific
stuff in our mainline code. Using hooks, the function becomes:
- function showAnArticle($article) {
+ function showAnArticle( $article ) {
- if (wfRunHooks('ArticleShow', array(&$article))) {
+ if ( Hooks::run( 'ArticleShow', array( &$article ) ) ) {
# code to actually show the article goes here
- wfRunHooks('ArticleShowComplete', array(&$article));
+ Hooks::run( 'ArticleShowComplete', array( &$article ) );
}
}
@@ -93,11 +93,11 @@
deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
file:
- function reverseArticleTitle($article) {
+ function reverseArticleTitle( $article ) {
# ...
}
- function reverseForExport($article) {
+ function reverseForExport( $article ) {
# ...
}
@@ -139,29 +139,29 @@
event. All the following are valid ways to define hooks:
$wgHooks['EventName'][] = 'someFunction'; # function, no data
- $wgHooks['EventName'][] = array('someFunction', $someData);
- $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
+ $wgHooks['EventName'][] = array( 'someFunction', $someData );
+ $wgHooks['EventName'][] = array( 'someFunction' ); # weird, but OK
$wgHooks['EventName'][] = $object; # object only
- $wgHooks['EventName'][] = array($object, 'someMethod');
- $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
- $wgHooks['EventName'][] = array($object); # weird but OK
+ $wgHooks['EventName'][] = array( $object, 'someMethod' );
+ $wgHooks['EventName'][] = array( $object, 'someMethod', $someData );
+ $wgHooks['EventName'][] = array( $object ); # weird but OK
When an event occurs, the function (or object method) will be called with the
optional data provided as well as event-specific parameters. The above examples
would result in the following code being executed when 'EventName' happened:
# function, no data
- someFunction($param1, $param2)
+ someFunction( $param1, $param2 )
# function with data
- someFunction($someData, $param1, $param2)
+ someFunction( $someData, $param1, $param2 )
# object only
- $object->onEventName($param1, $param2)
+ $object->onEventName( $param1, $param2 )
# object with method
- $object->someMethod($param1, $param2)
+ $object->someMethod( $param1, $param2 )
# object with method and data
- $object->someMethod($someData, $param1, $param2)
+ $object->someMethod( $someData, $param1, $param2 )
Note that when an object is the hook, and there's no specified method, the
default method called is 'onEventName'. For different events this would be
@@ -170,8 +170,8 @@
The extra data is useful if we want to use the same function or object for
different purposes. For example:
- $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
- $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
+ $wgHooks['ArticleSaveComplete'][] = array( 'ircNotify', 'TimStarling' );
+ $wgHooks['ArticleSaveComplete'][] = array( 'ircNotify', 'brion' );
This code would result in ircNotify being run twice when an article is saved:
once for 'TimStarling', and once for 'brion'.
@@ -188,9 +188,9 @@
functionality. For example, if you wanted to authenticate users to a custom
system (LDAP, another PHP program, whatever), you could do:
- $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
+ $wgHooks['UserLogin'][] = array( 'ldapLogin', $ldapServer );
- function ldapLogin($username, $password) {
+ function ldapLogin( $username, $password ) {
# log user into LDAP
return false;
}
@@ -204,28 +204,28 @@
==Using hooks==
-A calling function or method uses the wfRunHooks() function to run the hooks
+A calling function or method uses the Hooks::run() function to run the hooks
related to a particular event, like so:
class Article {
# ...
function protect() {
global $wgUser;
- if (wfRunHooks('ArticleProtect', array(&$this,
&$wgUser))) {
+ if ( Hooks::run( 'ArticleProtect', array( &$this,
&$wgUser ) ) ) {
# protect the article
- wfRunHooks('ArticleProtectComplete',
array(&$this, &$wgUser));
+ Hooks::run( 'ArticleProtectComplete', array(
&$this, &$wgUser ) );
}
}
}
-wfRunHooks() returns true if the calling function should continue processing
+Hooks::run() returns true if the calling function should continue processing
(the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
error occurred, or one of the hooks handled the action already). Checking the
return value matters more for "before" hooks than for "complete" hooks.
Note that hook parameters are passed in an array; this is a necessary
inconvenience to make it possible to pass reference values (that can be
changed)
-into the hook code. Also note that earlier versions of wfRunHooks took a
+into the hook code. Also note that earlier versions of Hooks::run took a
variable number of arguments; the array() calling protocol came about after
MediaWiki 1.4rc1.
--
To view, visit https://gerrit.wikimedia.org/r/196602
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I0297e389eb761822b0b5b9ea7a0a0a7990790677
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
